From 07eb81075334c7058b8043fcc5176266286c6052 Mon Sep 17 00:00:00 2001
From: dfurrer <none@none>
Date: Wed, 4 Nov 2015 18:17:39 +0100
Subject: [PATCH] OO-1658: contextHelp cleanup
---
.../contextHelp/ContextHelpComponent.java | 2 +-
...DeliveryOptionsConfigurationController.java | 18 +++++++++++-------
.../generic/wizard/StepsMainRunController.java | 8 +++++++-
.../generic/wizard/_content/stepslayout.html | 3 +++
.../course/editor/EditorMainController.java | 2 +-
.../course/nodes/cal/_content/edit_access.html | 2 +-
.../cl/ui/wizard/MetadatasStepController.java | 3 +--
.../olat/course/nodes/cp/CPEditController.java | 2 +-
.../gta/ui/GTAWorkflowEditController.java | 1 +
.../nodes/gta/ui/_content/edit_task_list.html | 2 +-
.../gta/ui/_i18n/LocalStrings_de.properties | 2 +-
.../gta/ui/_i18n/LocalStrings_en.properties | 2 +-
.../nodes/members/MembersConfigForm.java | 1 +
.../nodes/scorm/ScormEditController.java | 2 +-
.../olat/course/nodes/sp/SPEditController.java | 2 +-
.../nodes/st/STCourseNodeEditController.java | 4 ++--
.../olat/ims/cp/ui/CPRuntimeController.java | 2 +-
.../ui/OpenMeetingsRoomEditController.java | 3 ++-
.../modules/scorm/ScormRuntimeController.java | 4 ++--
19 files changed, 40 insertions(+), 25 deletions(-)
diff --git a/src/main/java/org/olat/core/commons/contextHelp/ContextHelpComponent.java b/src/main/java/org/olat/core/commons/contextHelp/ContextHelpComponent.java
index c2605556c41..8f1763f86b9 100644
--- a/src/main/java/org/olat/core/commons/contextHelp/ContextHelpComponent.java
+++ b/src/main/java/org/olat/core/commons/contextHelp/ContextHelpComponent.java
@@ -78,7 +78,7 @@ public class ContextHelpComponent extends AbstractComponent {
}
/**
- *
+ *
* @param name Name of the component
* @param packageName Package name where the help is
* @param pageName The name of the page of this specific context help
diff --git a/src/main/java/org/olat/core/gui/control/generic/iframe/DeliveryOptionsConfigurationController.java b/src/main/java/org/olat/core/gui/control/generic/iframe/DeliveryOptionsConfigurationController.java
index 8fda4f2e8de..d9f0cddda42 100644
--- a/src/main/java/org/olat/core/gui/control/generic/iframe/DeliveryOptionsConfigurationController.java
+++ b/src/main/java/org/olat/core/gui/control/generic/iframe/DeliveryOptionsConfigurationController.java
@@ -51,7 +51,8 @@ public class DeliveryOptionsConfigurationController extends FormBasicController
private SingleSelection jsOptionEl, cssOptionEl;
private SingleSelection encodingContentEl, encodingJSEl, heightEl;
private MultipleSelectionElement glossarEl;
-
+ private String helpPage;
+
private static final String[] jsKeys = new String[] {"none", "jQuery", "prototypejs" };
private static final String[] cssKeys = new String[] {"none", "openolat" };
@@ -72,15 +73,16 @@ public class DeliveryOptionsConfigurationController extends FormBasicController
private static final String[] standardModeKeys = new String[]{ "standard", "configured" };
private static final String[] inheritKeys = new String[]{ "inherit", "custom"};
-
- public DeliveryOptionsConfigurationController(UserRequest ureq, WindowControl wControl, DeliveryOptions config) {
- this(ureq, wControl, config, null);
+
+ public DeliveryOptionsConfigurationController(UserRequest ureq, WindowControl wControl, DeliveryOptions config, String helpPage) {
+ this(ureq, wControl, config, helpPage, null);
}
-
- public DeliveryOptionsConfigurationController(UserRequest ureq, WindowControl wControl, DeliveryOptions config, DeliveryOptions parentConfig) {
+
+ public DeliveryOptionsConfigurationController(UserRequest ureq, WindowControl wControl, DeliveryOptions config, String helpPage, DeliveryOptions parentConfig) {
super(ureq, wControl);
this.config = (config == null ? new DeliveryOptions() : config.clone());
this.parentConfig = parentConfig;
+ this.helpPage = helpPage;
initForm(ureq);
if(parentConfig != null && config != null && config.getInherit() != null && config.getInherit().booleanValue()) {
@@ -143,7 +145,9 @@ public class DeliveryOptionsConfigurationController extends FormBasicController
@Override
protected void initForm(FormItemContainer formLayout, Controller listener, UserRequest ureq) {
setFormTitle("option.desc");
- setFormContextHelp("Knowledge Transfer");
+ if(helpPage != null || helpPage != ""){
+ setFormContextHelp(helpPage);
+ }
String[] inheritValues = new String[]{
translate("inherit"), translate("custom")
diff --git a/src/main/java/org/olat/core/gui/control/generic/wizard/StepsMainRunController.java b/src/main/java/org/olat/core/gui/control/generic/wizard/StepsMainRunController.java
index d63006dcd10..e97e87ffcb1 100644
--- a/src/main/java/org/olat/core/gui/control/generic/wizard/StepsMainRunController.java
+++ b/src/main/java/org/olat/core/gui/control/generic/wizard/StepsMainRunController.java
@@ -130,18 +130,24 @@ public class StepsMainRunController extends FormBasicController implements Gener
private StepRunnerCallback finish;
private boolean finishCycle = false;
+
+ public StepsMainRunController(UserRequest ureq, WindowControl control, Step startStep, StepRunnerCallback finish,
+ StepRunnerCallback cancel, String wizardTitle, String elementCssClass) {
+ this(ureq, control, startStep, finish, cancel, wizardTitle, elementCssClass, "");
+ }
/**
* @param ureq
* @param control
*/
public StepsMainRunController(UserRequest ureq, WindowControl control, Step startStep, StepRunnerCallback finish,
- StepRunnerCallback cancel, String wizardTitle, String elementCssClass) {
+ StepRunnerCallback cancel, String wizardTitle, String elementCssClass, String contextHelpPage) {
super(ureq, control, "stepslayout");
this.finish = finish;
this.cancel = cancel;
flc.contextPut("wizardTitle", wizardTitle);
flc.contextPut("elementCssClass", elementCssClass);
+ flc.contextPut("helpPage", contextHelpPage);
this.startStep = startStep;
steps = new Stack<Step>();
diff --git a/src/main/java/org/olat/core/gui/control/generic/wizard/_content/stepslayout.html b/src/main/java/org/olat/core/gui/control/generic/wizard/_content/stepslayout.html
index 2bf1cf2e379..76479c33a24 100644
--- a/src/main/java/org/olat/core/gui/control/generic/wizard/_content/stepslayout.html
+++ b/src/main/java/org/olat/core/gui/control/generic/wizard/_content/stepslayout.html
@@ -1,6 +1,9 @@
<div class="o_wizard modal show in"><div class="modal-backdrop in"></div><div class="modal-dialog modal-lg o_modal_fullwidth #if($elementCssClass) $elementCssClass #end"><div class="modal-content">
<div class="modal-header">
<div class="pull-right">$r.render("closeIcon")</div>
+ #if( "$helpPage" != "")
+ $r.contextHelpWithWrapper("$helpPage")
+ #end
<h4>$wizardTitle</h4>
</div>
<div class="modal-body">
diff --git a/src/main/java/org/olat/course/editor/EditorMainController.java b/src/main/java/org/olat/course/editor/EditorMainController.java
index 45439bc9113..6a007ff9076 100644
--- a/src/main/java/org/olat/course/editor/EditorMainController.java
+++ b/src/main/java/org/olat/course/editor/EditorMainController.java
@@ -1167,7 +1167,7 @@ public class EditorMainController extends MainLayoutBasicController implements G
Step start = new CheckList_1_CheckboxStep(ureq, ores);
StepRunnerCallback finish = new CheckListStepRunnerCallback(ores);
checklistWizard = new StepsMainRunController(ureq, getWindowControl(), start, finish, null,
- translate("checklist.wizard"), "o_sel_checklist_wizard");
+ translate("checklist.wizard"), "o_sel_checklist_wizard", "Assessment#_checklist_multiple");
listenTo(checklistWizard);
getWindowControl().pushAsModalDialog(checklistWizard.getInitialComponent());
}
diff --git a/src/main/java/org/olat/course/nodes/cal/_content/edit_access.html b/src/main/java/org/olat/course/nodes/cal/_content/edit_access.html
index e33b8c64ffa..c30e13a239c 100644
--- a/src/main/java/org/olat/course/nodes/cal/_content/edit_access.html
+++ b/src/main/java/org/olat/course/nodes/cal/_content/edit_access.html
@@ -4,7 +4,7 @@
$r.render("editCondition")
</fieldset>
<fieldset class="clearfix">
- <legend>$r.contextHelpWithWrapper("General Configuration of Course Elements#_zugang")
+ <legend>
$r.translate("condition.accessibility.title")</legend>
$r.render("readerCondition")
</fieldset>
diff --git a/src/main/java/org/olat/course/nodes/cl/ui/wizard/MetadatasStepController.java b/src/main/java/org/olat/course/nodes/cl/ui/wizard/MetadatasStepController.java
index 05f4d67ef66..2631504ce24 100644
--- a/src/main/java/org/olat/course/nodes/cl/ui/wizard/MetadatasStepController.java
+++ b/src/main/java/org/olat/course/nodes/cl/ui/wizard/MetadatasStepController.java
@@ -62,8 +62,7 @@ public class MetadatasStepController extends StepFormBasicController {
protected void initForm(FormItemContainer formLayout, Controller listener, UserRequest ureq) {
setFormTitle("metadatas.details");
setFormDescription("metadatas.details.description");
- setFormContextHelp("org.olat.course.nodes.cl.ui", "cl-metadatas.html", "help.hover.metadatas");
-
+
if(formLayout instanceof FormLayoutContainer) {
FormLayoutContainer layoutCont = (FormLayoutContainer)formLayout;
diff --git a/src/main/java/org/olat/course/nodes/cp/CPEditController.java b/src/main/java/org/olat/course/nodes/cp/CPEditController.java
index 6580b4fc7c4..3028e348d8e 100644
--- a/src/main/java/org/olat/course/nodes/cp/CPEditController.java
+++ b/src/main/java/org/olat/course/nodes/cp/CPEditController.java
@@ -180,7 +180,7 @@ public class CPEditController extends ActivateableTabbableDefaultController impl
listenTo(accessibilityCondContr);
DeliveryOptions deliveryOptions = (DeliveryOptions)config.get(CPEditController.CONFIG_DELIVERYOPTIONS);
- deliveryOptionsCtrl = new DeliveryOptionsConfigurationController(ureq, getWindowControl(), deliveryOptions, parentConfig);
+ deliveryOptionsCtrl = new DeliveryOptionsConfigurationController(ureq, getWindowControl(), deliveryOptions, "Knowledge Transfer#_cp_layout", parentConfig);
listenTo(deliveryOptionsCtrl);
main.setContent(cpConfigurationVc);
diff --git a/src/main/java/org/olat/course/nodes/gta/ui/GTAWorkflowEditController.java b/src/main/java/org/olat/course/nodes/gta/ui/GTAWorkflowEditController.java
index 227b736a567..c67d9c31114 100644
--- a/src/main/java/org/olat/course/nodes/gta/ui/GTAWorkflowEditController.java
+++ b/src/main/java/org/olat/course/nodes/gta/ui/GTAWorkflowEditController.java
@@ -195,6 +195,7 @@ public class GTAWorkflowEditController extends FormBasicController {
stepsCont.setFormDescription(translate("task.steps.description"));
stepsCont.setElementCssClass("o_sel_course_gta_steps");
stepsCont.setRootForm(mainForm);
+ stepsCont.setFormContextHelp("Assessment#_task_workflow");
formLayout.add(stepsCont);
relativeDatesEl = uifactory.addCheckboxesHorizontal("relative.dates", "relative.dates", stepsCont, onKeys, new String[]{ "" });
diff --git a/src/main/java/org/olat/course/nodes/gta/ui/_content/edit_task_list.html b/src/main/java/org/olat/course/nodes/gta/ui/_content/edit_task_list.html
index 682a349275f..deef7d76095 100644
--- a/src/main/java/org/olat/course/nodes/gta/ui/_content/edit_task_list.html
+++ b/src/main/java/org/olat/course/nodes/gta/ui/_content/edit_task_list.html
@@ -1,5 +1,5 @@
<fieldset class="o_form o_block_large_bottom o_sel_course_gta_tasks" role="form">
- <legend>$r.translate("task.list.title")</legend>
+ <legend>$r.translate("task.list.title") $r.contextHelpWithWrapper("Assessment#_task_aufgabe")</legend>
<div class="o_desc">$r.translate("task.list.description")</div>
<div class="o_button_group o_button_group_right"><div class="btn-group">
$r.render("add.task") $r.render("create.task")
diff --git a/src/main/java/org/olat/course/nodes/gta/ui/_i18n/LocalStrings_de.properties b/src/main/java/org/olat/course/nodes/gta/ui/_i18n/LocalStrings_de.properties
index 3d9200c9527..05642272146 100644
--- a/src/main/java/org/olat/course/nodes/gta/ui/_i18n/LocalStrings_de.properties
+++ b/src/main/java/org/olat/course/nodes/gta/ui/_i18n/LocalStrings_de.properties
@@ -217,7 +217,7 @@ task.steps.title=Abschnitte
task.successfully.assigned=Aufgabe erfolgreich zugewiesen.
task.text=$org.olat.course.nodes.ta\:form.task.text
task.title=Titel
-task.type.description=Wenn die Gruppenaufgabe aktiviert ist, werden alle Abschnitte des Workflows als Gruppe und nicht als Einzelperson ausgef\u00FChrt.
+task.type.description=W\u00E4hlen Sie eine oder mehrere Gruppen / Lernbereiche aus, um die Aufgabe zuzuweisen. In der Gruppenaufgabe werden alle Abschnitte des Workflows als Gruppe und nicht als Einzelperson ausgef\u00FChrt.
task.type.title=Aufgabentyp
upload.document=Dokument hochladen
uploaded.by=hochgeladen von {0}
diff --git a/src/main/java/org/olat/course/nodes/gta/ui/_i18n/LocalStrings_en.properties b/src/main/java/org/olat/course/nodes/gta/ui/_i18n/LocalStrings_en.properties
index 97c5a6c61af..b9842ccd2a0 100644
--- a/src/main/java/org/olat/course/nodes/gta/ui/_i18n/LocalStrings_en.properties
+++ b/src/main/java/org/olat/course/nodes/gta/ui/_i18n/LocalStrings_en.properties
@@ -217,7 +217,7 @@ task.steps.title=Workflow steps
task.successfully.assigned=The task was successfully assigned to you.
task.text=$org.olat.course.nodes.ta\:form.task.text
task.title=Title
-task.type.description=When group task is enabled, all steps of the workflow are executed as a group and not as an individual.
+task.type.description=Choose one or more groups and/or learning areas in order to assign the group task. In the group task are all steps of the workflow executed as a group and not as an individual.
task.type.title=Task type
upload.document=Upload document
uploaded.by=uploaded by
diff --git a/src/main/java/org/olat/course/nodes/members/MembersConfigForm.java b/src/main/java/org/olat/course/nodes/members/MembersConfigForm.java
index e15e84fff25..36dc9eb85b6 100755
--- a/src/main/java/org/olat/course/nodes/members/MembersConfigForm.java
+++ b/src/main/java/org/olat/course/nodes/members/MembersConfigForm.java
@@ -107,6 +107,7 @@ public class MembersConfigForm extends FormBasicController {
// set Formtitle and infobar
this.setFormTitle("pane.tab.membersconfig");
this.setFormInfo("members.info");
+ this.setFormContextHelp("Communication and Collaboration#_teilnehmerliste");
// Read Configuration
boolean showOwnerConfig = config
.getBooleanSafe(MembersCourseNodeEditController.CONFIG_KEY_SHOWOWNER);
diff --git a/src/main/java/org/olat/course/nodes/scorm/ScormEditController.java b/src/main/java/org/olat/course/nodes/scorm/ScormEditController.java
index 9a327e5f021..0831138d1f5 100644
--- a/src/main/java/org/olat/course/nodes/scorm/ScormEditController.java
+++ b/src/main/java/org/olat/course/nodes/scorm/ScormEditController.java
@@ -221,7 +221,7 @@ public class ScormEditController extends ActivateableTabbableDefaultController i
listenTo(accessibilityCondContr);
DeliveryOptions deliveryOptions = (DeliveryOptions)config.get(CONFIG_DELIVERY_OPTIONS);
- deliveryOptionsCtrl = new DeliveryOptionsConfigurationController(ureq, getWindowControl(), deliveryOptions, parentConfig);
+ deliveryOptionsCtrl = new DeliveryOptionsConfigurationController(ureq, getWindowControl(), deliveryOptions, "Knowledge Transfer#_scorm_layout" , parentConfig);
listenTo(deliveryOptionsCtrl);
main.setContent(cpConfigurationVc);
diff --git a/src/main/java/org/olat/course/nodes/sp/SPEditController.java b/src/main/java/org/olat/course/nodes/sp/SPEditController.java
index a745985256a..68470ab5695 100644
--- a/src/main/java/org/olat/course/nodes/sp/SPEditController.java
+++ b/src/main/java/org/olat/course/nodes/sp/SPEditController.java
@@ -144,7 +144,7 @@ public class SPEditController extends ActivateableTabbableDefaultController impl
// Delivery options form
DeliveryOptions deliveryOptions = (DeliveryOptions)moduleConfiguration.get(CONFIG_KEY_DELIVERYOPTIONS);
- deliveryOptionsCtrl = new DeliveryOptionsConfigurationController(ureq, getWindowControl(), deliveryOptions);
+ deliveryOptionsCtrl = new DeliveryOptionsConfigurationController(ureq, getWindowControl(), deliveryOptions, "Knowledge Transfer#_splayout");
listenTo(deliveryOptionsCtrl);
}
diff --git a/src/main/java/org/olat/course/nodes/st/STCourseNodeEditController.java b/src/main/java/org/olat/course/nodes/st/STCourseNodeEditController.java
index 9226bad6578..6e19231b0fa 100644
--- a/src/main/java/org/olat/course/nodes/st/STCourseNodeEditController.java
+++ b/src/main/java/org/olat/course/nodes/st/STCourseNodeEditController.java
@@ -171,8 +171,8 @@ public class STCourseNodeEditController extends ActivateableTabbableDefaultContr
if (editorEnabled) {
addCustomFileConfigToView(ureq);
}
-
- deliveryOptionsCtrl = new DeliveryOptionsConfigurationController(ureq, getWindowControl(), deliveryOptions);
+
+ deliveryOptionsCtrl = new DeliveryOptionsConfigurationController(ureq, getWindowControl(), deliveryOptions, "Knowledge Transfer#_splayout");
listenTo(deliveryOptionsCtrl);
// Find assessable children nodes
diff --git a/src/main/java/org/olat/ims/cp/ui/CPRuntimeController.java b/src/main/java/org/olat/ims/cp/ui/CPRuntimeController.java
index cdff441839b..0b66c48be24 100644
--- a/src/main/java/org/olat/ims/cp/ui/CPRuntimeController.java
+++ b/src/main/java/org/olat/ims/cp/ui/CPRuntimeController.java
@@ -142,7 +142,7 @@ public class CPRuntimeController extends RepositoryEntryRuntimeController {
DeliveryOptions config = cpConfig == null ? null : cpConfig.getDeliveryOptions();
WindowControl bwControl = getSubWindowControl("Layout");
final DeliveryOptionsConfigurationController deliveryOptionsCtrl
- = new DeliveryOptionsConfigurationController(ureq, addToHistory(ureq, bwControl), config);
+ = new DeliveryOptionsConfigurationController(ureq, addToHistory(ureq, bwControl), config, "Knowledge Transfer#_cp_layout");
deliveryOptionsCtrl.addControllerListener(new ControllerEventListener() {
@Override
diff --git a/src/main/java/org/olat/modules/openmeetings/ui/OpenMeetingsRoomEditController.java b/src/main/java/org/olat/modules/openmeetings/ui/OpenMeetingsRoomEditController.java
index b1e0c175e63..7268e1142ae 100644
--- a/src/main/java/org/olat/modules/openmeetings/ui/OpenMeetingsRoomEditController.java
+++ b/src/main/java/org/olat/modules/openmeetings/ui/OpenMeetingsRoomEditController.java
@@ -79,7 +79,8 @@ public class OpenMeetingsRoomEditController extends FormBasicController {
this.ores = ores;
this.subIdentifier = subIdentifier;
this.defaultSettings = defaultSettings;
-
+ this.setFormContextHelp("Communication and Collaboration#_openmeeting_raum");
+
roomTypeKeys = new String[]{
RoomType.conference.typeStr(), RoomType.restricted.typeStr(), RoomType.interview.typeStr()
};
diff --git a/src/main/java/org/olat/modules/scorm/ScormRuntimeController.java b/src/main/java/org/olat/modules/scorm/ScormRuntimeController.java
index 9f5a6f1ad8a..a60e2a7a66d 100644
--- a/src/main/java/org/olat/modules/scorm/ScormRuntimeController.java
+++ b/src/main/java/org/olat/modules/scorm/ScormRuntimeController.java
@@ -99,8 +99,8 @@ public class ScormRuntimeController extends RepositoryEntryRuntimeController {
final OLATResource resource = entry.getOlatResource();
WindowControl bwControl = getSubWindowControl("Layout");
final DeliveryOptionsConfigurationController deliveryOptionsCtrl
- = new DeliveryOptionsConfigurationController(ureq, addToHistory(ureq, bwControl), config);
-
+ = new DeliveryOptionsConfigurationController(ureq, addToHistory(ureq, bwControl), config, "Knowledge Transfer#_scorm_layout");
+
deliveryOptionsCtrl.addControllerListener(new ControllerEventListener() {
@Override
public void dispatchEvent(UserRequest uureq, Controller source, Event event) {
--
GitLab