feat(schedule): implement explanatory text

src/Handler/Schedule.hs

@@ -5,6 +5,7 @@ module Handler.Schedule
 import Import
 
 import Handler.Utils.Form
+import Handler.Utils.I18n
 
 import Utils.Schedule.Types
 import Utils.Schedule.Week
@@ -97,6 +98,8 @@ postScheduleR = do
     FormSuccess ScheduleOptions{scheduleView=ScheduleViewWeek,..} -> return $ weekSchedule user scheduleOffset
     other -> formFailure2Alerts other >> return mempty
 
+  let scheduleExplanation = $(i18nWidgetFile "schedule-explanation")
+
   siteLayoutMsg MsgMenuSchedule $ do
     setTitleI MsgMenuSchedule
     $(widgetFile "schedule")

templates/i18n/schedule-explanation/de-de-formal.hamlet

@@ -0,0 +1,17 @@
+$# TODO: Erklärungen (bzw. Teile davon) in FAQ wiederverwenden
+
+<p>
+  In Ihrer persönlichen Terminübersicht werden Ihnen Ihre Termine zu Uni2work-Kursen angezeigt.
+
+<p>
+  Sie können auf einzelne Termine in Ihrer Terminübersicht klicken, um zum jeweiligen Kurs, zum jeweiligen Tutorium oder zur jeweiligen Prüfung zu gelangen.
+
+<p>
+  Es gibt die Möglichkeit, einzelne Termine aus Ihrer Terminübersicht auszublenden. Wenn Sie einzelne Termine aus Ihrer persönlichen Terminübersicht ausblenden möchten, dann klicken Sie zunächst auf den jeweils auszublendenden Termin, und fügen dann über den Knopf "Aus Terminübersicht ausblenden" eine Ausnahme für diesen Termin hinzu. <br />
+  Analog dazu können Sie ausgeblendete Termine auch in Ihrer Terminübersicht einblenden, indem Sie den Knopf "In Terminübersicht zeigen" betätigen; diesen finden Sie an der gleichen Stelle, an der sonst der Knopf "Aus Terminübersicht ausblenden" zu finden ist. Alternativ können Sie auch über Ihre Benutzereinstellungen Ihre Terminausnahmen einsehen und entfernen. <br />
+  In Ihren Benutzereinstellungen können Sie festlegen, ob Termine von Kursen, zu denen Sie sich neu anmelden standardmäßig in Ihrer Terminübersicht angezeigt werden sollen.
+
+<p>
+  In Ihren Benutzereinstellungen haben Sie verschiedene Möglichkeiten, die Anzeige Ihrer Terminübersicht zu beeinflussen. <br />
+  Beispielsweise können Sie dort in der Wochenübersicht darzustellende Wochentage festlegen (Samstag und Sonntag sind standrdmäßig ausgeblendet, wenn Sie an diesem Tag keinen Termin haben), oder auch Beginn und Ende (Uhrzeit) eines Tages in der Wochenübersicht sowie die Länge der darzustellenden Zeitslots (d.h. einer Zeilen) festlegen. Sie können dort auch festlegen, ob Termine von Kursen, zu denen Sie sich neu anmelden standardmäßig in Ihrem Stundenplan angezeigt werden sollen.
+  Die relevanten Einstellungen hierzu finden Sie in Ihren Benutzereinstellungen (diese erreichen Sie über "Anpassen" rechts oben), und dort in der Sektion "Terminübersicht".

templates/i18n/schedule-explanation/en-eu.hamlet

@@ -0,0 +1,18 @@
+$# TODO: Erklärungen (bzw. Teile davon) in FAQ wiederverwenden
+
+<p>
+  This is your personal schedule, in which your appointments for your Uni2work courses are displayed.
+
+<p>
+  You can click on a specific appointment to reach the respective course, tutorial or exam.
+
+<p>
+  You may hide specific appointments from your personal schedule. To hide a specific appointment, please click on the appointment in your schedule, and hit the button "Hide from schedule" there to opt-out of this appointment in your schedule. <br />
+  Similarly, you may also show specific appointments in your schedule; in this case, hit the button "Show in schedule" (which will be displayed at the same place where you normally find the button "Hide from schedule"). Alternatively, you may also view and remove your appointment display opt-ins/opt-outs in your user settings. <br />
+  In your user settings, you may specify whether appointments for courses should be displayed by default after you registered for the course.
+
+<p>
+  You may change the look and behaviour of your personal schedule in various ways in your user settings. <br />
+  Beispielsweise können Sie dort in der Wochenübersicht darzustellende Wochentage festlegen (Samstag und Sonntag sind standrdmäßig ausgeblendet, wenn Sie an diesem Tag keinen Termin haben), oder auch Beginn und Ende (Uhrzeit) eines Tages in der Wochenübersicht sowie die Länge der darzustellenden Zeitslots (d.h. einer Zeilen) festlegen. Sie können dort auch festlegen, ob Termine von Kursen, zu denen Sie sich neu anmelden standardmäßig in Ihrem Stundenplan angezeigt werden sollen.
+  For example, you may change the weekdays which should be displayed by default in your weekly schedule (Saturdays and Sundays are hidden by default if you do not have any appointments on this day), or you may change the begin and end (time) of each day in your weekly schedule such as the length of each time slot (i.e. the time length of each row). You may also specify whether appointments for new courses should be displayed in your schedule by default after you register for the course. <br />
+  All relevant settings can be found in your user settings (which you can view via "Settings" in the upper right corner), and there under the section "Schedule".

templates/schedule.hamlet

@@ -1,6 +1,10 @@
 $newline never
 
-^{schedule}
+<section>
+  ^{schedule}
 
-<form enctype=#{optionsEnctype} .schedule-options>
-  ^{optionsWidget}
+  <form enctype=#{optionsEnctype} .schedule-options>
+    ^{optionsWidget}
+
+<section .explanation>
+  ^{scheduleExplanation}