diff --git a/doc/create-studyplan.htm b/doc/create-studyplan.htm index ae242f5..6789394 100644 --- a/doc/create-studyplan.htm +++ b/doc/create-studyplan.htm @@ -67,6 +67,32 @@

To re-arrange the courses in the study plan, simply drag and drop them from the places they are now in.

To remove a course from the study plan, simply drag it to the red garbage bin that appears on dragging

+ +

Layers within a study line

+ To add a course to a new layer within a studyline, drag it to the bottom of the study line. There are small slots shown there, which + will fully open when the course is dragged over them +

+ +

Configuring periods

 + All periods in the study plan will have a label showing the timing and it's short name directly above their course columns in the + timeline. Upon hovering over the short name, it's full name will appear.
+ Also, the period matching the current date, will be highlighted in the color + indicated by the 
--highlight
css variable, which corresponds to the + value of the 
--info
color by default. +

+ +

+

+

At the start, the periods start and end times will be naively selected by splitting the study plan's duration among the number of periods.
+ By clicking on the icon, you can open the edit screen and change the period's full name, + short name, start time and end time +

+

+

+
TIP:
+ Before you start dragging courses into a studyplan page, make sure you have the periods configured correctly. +
+

Configuring courses

Once a course is added to the studyplan, an icon shows if it needs to be configured () or is already configured ().

@@ -84,6 +110,28 @@ such will all need to be completed for the course to be marked as completed, regardless of the minimum percentage configured

+

Course start and end times

+

Often, the course will have their start and end times configured differently than the period you drop them in. If this is the case, + a screen will appear asking if you want to update the course's start and end times. The time details of both course and period will + be shown for your comparison. By clicking , the course's start and end times will be + updated to those of the period. Any activity dates set will be adjusted according to the changed start date.

+

+
NOTE:
+

If you do not change the course start and end times at this moment, you always have the opportunity later on + by clicking the icon in the course detail screen. (As seen in the screenshot below).

+

This icon will be (color --success) to indicate if the course timing matches + period timing. If not, it is shown as (color --warning)

+
+ +

Courses spanning multiple periods

+

If a course should span multiple periods, you can specify this in the course detail screen.
+ On the top right of the course details screen you can select the desired period span of this course. + Do note however, that the available spans are limited by the available space to the right of the course in the studyplan

+

+

Upon selecting the span you want, the course display will immediately be updated to reflect the changes.
+ immediately after this, you will see the screen asking if you want to change the course start and end times to reflect the + new period span.

+

Adding badges

The toolbox also shows you the site-wide badges that are available for students. These can be dragged into the slots around and between the courses.

When you click on the icon in the badge it shows you additional information about the badge

diff --git a/doc/img/Course-timing-change.png b/doc/img/Course-timing-change.png new file mode 100644 index 0000000..a98dd7a Binary files /dev/null and b/doc/img/Course-timing-change.png differ diff --git a/doc/img/Course-timing-indicators.png b/doc/img/Course-timing-indicators.png new file mode 100644 index 0000000..cbb93ea Binary files /dev/null and b/doc/img/Course-timing-indicators.png differ diff --git a/doc/img/Course-timing-mismatch-screen.png b/doc/img/Course-timing-mismatch-screen.png new file mode 100644 index 0000000..dff75d3 Binary files /dev/null and b/doc/img/Course-timing-mismatch-screen.png differ diff --git a/doc/img/Period-edit.png b/doc/img/Period-edit.png new file mode 100644 index 0000000..ffe16e1 Binary files /dev/null and b/doc/img/Period-edit.png differ diff --git a/doc/img/Period-hover.png b/doc/img/Period-hover.png new file mode 100644 index 0000000..d4bfba3 Binary files /dev/null and b/doc/img/Period-hover.png differ diff --git a/doc/img/Period-plan-multispan.png b/doc/img/Period-plan-multispan.png new file mode 100644 index 0000000..f2ca297 Binary files /dev/null and b/doc/img/Period-plan-multispan.png differ diff --git a/doc/img/Periods-in-plan.png b/doc/img/Periods-in-plan.png new file mode 100644 index 0000000..32ad7c9 Binary files /dev/null and b/doc/img/Periods-in-plan.png differ diff --git a/doc/img/Studyplan-draglayers.png b/doc/img/Studyplan-draglayers.png new file mode 100644 index 0000000..fc32624 Binary files /dev/null and b/doc/img/Studyplan-draglayers.png differ