From 3d8f36b342b48bae694e0b49b7aa80951f05b23b Mon Sep 17 00:00:00 2001
From: uhensler <urs.hensler@frentix.com>
Date: Mon, 18 Feb 2019 15:53:42 +0100
Subject: [PATCH] OO-3855: Help texts

---
 .../org/olat/modules/forms/ui/RubricEditorController.java  | 7 +++++++
 .../olat/modules/forms/ui/_i18n/LocalStrings_de.properties | 6 ++++++
 .../olat/modules/forms/ui/_i18n/LocalStrings_en.properties | 5 +++++
 3 files changed, 18 insertions(+)

diff --git a/src/main/java/org/olat/modules/forms/ui/RubricEditorController.java b/src/main/java/org/olat/modules/forms/ui/RubricEditorController.java
index 8bddef15880..0c070ea9ca4 100644
--- a/src/main/java/org/olat/modules/forms/ui/RubricEditorController.java
+++ b/src/main/java/org/olat/modules/forms/ui/RubricEditorController.java
@@ -187,6 +187,7 @@ public class RubricEditorController extends FormBasicController implements PageE
 
 		// name
 		nameEl = uifactory.addTextElement("rubric.name", 128, rubric.getName(), settingsLayout);
+		nameEl.setHelpTextKey("rubric.name.help", null);
 		
 		// name display
 		String[] nameDisplayValues = new String[] { translate("rubric.name.execution"), translate("rubric.name.report") };
@@ -195,6 +196,7 @@ public class RubricEditorController extends FormBasicController implements PageE
 		// scale type
 		scaleTypeEl = uifactory.addDropdownSingleselect("scale.type." + count.incrementAndGet(), "rubric.scale.type",
 				settingsLayout, ScaleType.getKeys(), ScaleType.getValues(getTranslator()), null);
+		scaleTypeEl.setHelpTextKey("rubric.scale.type.help", null);
 		scaleTypeEl.addActionListener(FormEvent.ONCHANGE);
 		scaleTypeEl.setEnabled(!restrictedEdit);
 		boolean scaleSelected = false;
@@ -213,6 +215,7 @@ public class RubricEditorController extends FormBasicController implements PageE
 		// good rating side
 		goodRatingEl = uifactory.addDropdownSingleselect("rubric.good.rating" + count.incrementAndGet(), "rubric.good.rating",
 				settingsLayout, GOOD_RATING_KEYS, translateAll(getTranslator(), GOOD_RATING_KEYS), null);
+		goodRatingEl.setHelpTextKey("rubric.good.rating.help", null);
 		goodRatingEl.addActionListener(FormEvent.ONCHANGE);
 		if (rubric != null) {
 			String goodRatingKey = rubric.isStartGoodRating()? GOOD_RATING_START_KEY: GOOD_RATING_END_KEY;
@@ -226,6 +229,7 @@ public class RubricEditorController extends FormBasicController implements PageE
 		insufficientCont.setRootForm(mainForm);
 		settingsLayout.add("insufficient", insufficientCont);
 		insufficientCont.setLabel("rubric.insufficient", null);
+		insufficientCont.setHelpTextKey("rubric.rating.help", new String[] { translate("rubric.insufficient")} );
 		String insufficientLowerBound = rubric.getLowerBoundInsufficient() != null
 				? String.valueOf(rubric.getLowerBoundInsufficient())
 				: null;
@@ -248,6 +252,7 @@ public class RubricEditorController extends FormBasicController implements PageE
 		neutralCont.setRootForm(mainForm);
 		settingsLayout.add("neutral", neutralCont);
 		neutralCont.setLabel("rubric.neutral", null);
+		neutralCont.setHelpTextKey("rubric.rating.help", new String[] { translate("rubric.neutral")} );
 		String neutralLowerBound = rubric.getLowerBoundNeutral() != null ? String.valueOf(rubric.getLowerBoundNeutral())
 				: null;
 		lowerBoundNeutralEl = uifactory.addTextElement("rubric.lower.bound.neutral", 4, neutralLowerBound, neutralCont);
@@ -266,6 +271,7 @@ public class RubricEditorController extends FormBasicController implements PageE
 		sufficientCont.setRootForm(mainForm);
 		settingsLayout.add("sufficient", sufficientCont);
 		sufficientCont.setLabel("rubric.sufficient", null);
+		sufficientCont.setHelpTextKey("rubric.rating.help", new String[] { translate("rubric.sufficient")} );
 		String sufficientLowerBound = rubric.getLowerBoundSufficient() != null
 				? String.valueOf(rubric.getLowerBoundSufficient())
 				: null;
@@ -286,6 +292,7 @@ public class RubricEditorController extends FormBasicController implements PageE
 		noAnswerEl = uifactory.addCheckboxesVertical("no.response." + count.incrementAndGet(),
 				"rubric.no.response.enabled", settingsLayout, ENABLED_KEYS,
 				translateAll(getTranslator(), ENABLED_KEYS), 1);
+		noAnswerEl.setHelpTextKey("no.response.help", null);
 		noAnswerEl.setEnabled(!restrictedEdit);
 		
 		uifactory.addSpacerElement("rubric.survey.configuration.upper", settingsLayout, false);
diff --git a/src/main/java/org/olat/modules/forms/ui/_i18n/LocalStrings_de.properties b/src/main/java/org/olat/modules/forms/ui/_i18n/LocalStrings_de.properties
index bc71527963f..199d287aeab 100644
--- a/src/main/java/org/olat/modules/forms/ui/_i18n/LocalStrings_de.properties
+++ b/src/main/java/org/olat/modules/forms/ui/_i18n/LocalStrings_de.properties
@@ -1,3 +1,4 @@
+
 #Thu Dec 15 14:28:31 CET 2016
 add.formcontainer=Container
 add.formdisclaimer=Nutzungsbedingungen
@@ -57,6 +58,7 @@ htitle=Titel
 multiple.choice.others=Weitere
 multiple.choice.with.others.enabled=Teilnehmer kann weitere Werte erfassen
 multiple.choice.with.others=Weitere
+no.response.help=Aktivieren Sie diese Option, um im Fragebogen die Spalte "Keine Antwort m\u00F6glich" anzuzeigen. Der Teilnehmer kann so zum Ausdruck bringen, dass er nicht in der Lage ist, eine Frage zu beantworten.
 no.response=Keine Antwort m\u00F6glich
 report.anonymous.user=Anonym
 report.count.count.title=Anzahl
@@ -94,6 +96,7 @@ reports.table.overview=\u00DCbersicht
 reports.table.report=Tabellen
 rubric.column.label=Spaltenbeschriftung
 rubric.good.rating.end=Rechts
+rubric.good.rating.help=Definieren Sie, ob die linke oder die rechte Seite der Skala eine positive Beurteilung darstellt. Diese Angabe wird f\u00FCr die Darstellung des Trenddiagramms verwendet.
 rubric.good.rating.start=Links
 rubric.good.rating=Positive Bewertung
 rubric.insufficient.explanation=Ungen\u00FCgende Beurteilung (Wert zwischen {0} und {1})
@@ -101,11 +104,13 @@ rubric.insufficient=Ungen\u00FCgend
 rubric.lower.bound=von
 rubric.name.display=Anzeige des Namens
 rubric.name.execution=In Durchf\u00FChrung
+rubric.name.help=Geben Sie diesem Rubric einen Namen und legen Sie fest, ob dieser im Fragebogen und in den Reports dargestellt werden soll. Im Report werden Rubrics ohne Namen zur Kennzeichnung durchnummeriert.
 rubric.name.report=In Reports
 rubric.name=Name
 rubric.neutral.explanation=Neutrale Beurteilung (Wert zwischen {0} und {1})
 rubric.neutral=Neutral
 rubric.no.response.enabled=Spalte "$\:no.response"
+rubric.rating.help=Definieren Sie den Bereich der Beurteilung "{0}". Die Beurteilung wird in den einzelnen Reports und in der Analyse von Umfragen verwendet. Zudem basieren die Kriterien einiger Datenerhebungsgeneratoren auf diesem Bereich.
 rubric.report.avg.abrev=\u00F8
 rubric.report.avg.title=Durchschnitt
 rubric.report.end.lable.title=
@@ -127,6 +132,7 @@ rubric.report.variance.title=Varianz
 rubric.scale.example.value=Wert: {0}
 rubric.scale.maxToOne=Absteigende Likert-Skala (x bis 1)
 rubric.scale.oneToMax=Aufsteigende Likert-Skala (1 bis x)
+rubric.scale.type.help=Legen Sie die Werte der gew\u00E4hlten Skala fest. Die Werte werden in den Reports und der Analyse von Umfragen verwendet.
 rubric.scale.type=Skalentyp
 rubric.scale.zeroBallanced=Symmetrische Likert-Skala (-x bis x)
 rubric.sufficient.explanation=Gute Beurteilung (Wert zwischen {0} und {1})
diff --git a/src/main/java/org/olat/modules/forms/ui/_i18n/LocalStrings_en.properties b/src/main/java/org/olat/modules/forms/ui/_i18n/LocalStrings_en.properties
index c54f2b11e63..af605a72b28 100644
--- a/src/main/java/org/olat/modules/forms/ui/_i18n/LocalStrings_en.properties
+++ b/src/main/java/org/olat/modules/forms/ui/_i18n/LocalStrings_en.properties
@@ -57,6 +57,7 @@ htitle=Title
 multiple.choice.others=Others
 multiple.choice.with.others.enabled=Participant can insert others values
 multiple.choice.with.others=Others
+no.response.help=Activate this option to display the column "No answer" in the questionnaire. The participant can express with that value that he is not able to answer a question.
 no.response=No answer
 report.anonymous.user=Anonymous
 report.count.count.title=Count
@@ -94,6 +95,7 @@ reports.table.overview=Overview
 reports.table.report=Tables
 rubric.column.label=Column label
 rubric.good.rating.end=Right
+rubric.good.rating.help=Define whether the left or right side of the scale represents a positive rating. This information is used to display the trend diagram.
 rubric.good.rating.start=Left
 rubric.good.rating=Positive rating
 rubric.insufficient.explanation=Good rating (Value between {0} and {1})
@@ -101,11 +103,13 @@ rubric.insufficient=Insufficient
 rubric.lower.bound=from
 rubric.name.display=Show name
 rubric.name.execution=In execution
+rubric.name.help=Give this rubric a name and specify whether it is to be displayed in the questionnaire and in the reports. In the report, rubrics without names are numbered consecutively for identification purposes.
 rubric.name.report=In reports
 rubric.name=Name
 rubric.neutral.explanation=Neutral assessment (value between {0} and {1})
 rubric.neutral=Neutral
 rubric.no.response.enabled=Column "$\:no.response"
+rubric.rating.help=Define the range of the rating "{0}". The rating is used in  reports and in the analysis of surveys. In addition, the criteria of some data collection generators are based on this range.
 rubric.report.avg.abrev=\u00F8
 rubric.report.avg.title=Average
 rubric.report.end.lable.title=
@@ -127,6 +131,7 @@ rubric.report.variance.title=Variance
 rubric.scale.example.value=Value\: {0}
 rubric.scale.maxToOne=Descending Likert scale (x to 1)
 rubric.scale.oneToMax=Ascending Likert scale (1 to x)
+rubric.scale.type.help=Specify the values of the selected scale. The values are used in reports and the survey analysis.
 rubric.scale.type=Scale type
 rubric.scale.zeroBallanced=Ballanced Likert scale (-x to x)
 rubric.sufficient.explanation=Good rating (Value between {0} and {1})
-- 
GitLab