custom-texts.md

CustomTexts

This application enables changes of texts during runtime. It's an implementation of the CustomTextPipe/CustomTextService of iqb-components. The idea is, that there might be some cases where the standard titles, prompts or explanations are not suitable for the specific environment the iqb-testcenter application is run in. One could change the source code and rebuild the application, but for minor changes we use this text replacement feature 'custom texts'.

This document describes the ways to bring the custom texts to the application and lists all possible keys.

Configuration file on the server

There is one file on the server where the application looks for custom texts:

/config/customTexts.json

These custom texts are loaded at (re)start of the application and the replacement starts as soon as possible. This is a simple JSON file with key value pairs. Example:

{
    "login_testEndButtonText": "Test beenden",
    "login_bookletSelectPrompt": "Bitte wählen",
...
}

The adminstrator of the server can upload this file. We aim at providing an administration feature of the super-admin section of the application to manage these texts.

Configuration via login configuration

For some tests, the test authority might like to change standard titles, prompts or explanations furthermore depending on the testtaker. For example, the questionnaire for teachers will use 'Please contact the administrator of the survey' and the booklet for students will prompt 'Please ask the test proctor'.

The login configuration goes with the XML file for the longin(s). There is one optional section 'CustomTexts' in every login file. Text replacements in this section will apply for every login of this file. Example:

<CustomTexts>
    <CustomText key="login_testEndButtonText">Test beenden</CustomText>
    <CustomText key="login_bookletSelectPrompt">Bitte wählen</CustomText>
...
</CustomTexts>

Configuration of System check

In the definition file for system checks, there is also one place to define text replacements:

<Config>
    <UploadSpeed ...
    <DownloadSpeed ...
    <CustomText key="syscheck_questionsintro">...</CustomText>
    <CustomText key="app_intro1">...</CustomText>
...
</Config>

List of possible replacements

Key	Used for	Default
app_intro1	Begrüßungstext auf der Startseite (Text nach IQB-Link)	betreibt auf diesen Seiten eine Anwendung für das computerbasierte Leistungstesten von Schülerinnen und Schülern. Der Zugang zu einem Test ist nur möglich, wenn Sie von Testverantwortlichen Zugangsdaten erhalten haben. Es sind keine weiteren Seiten öffentlich verfügbar.
app_title	Titel der Hauptanwendung	IQB-Testcenter
booklet_codeToEnterPrompt	Aufforderung für die Eingabe eines Freigabewortes (Dialog-Box)	Bitte gib das Freigabewort ein, das angesagt wurde!
booklet_codeToEnterTitle	Titel der Dialogbox für die Eingabe eines Freigabewortes	Freigabewort
booklet_errormessage	Nachricht an die Testperson, wenn ein schwerer Fehler aufgetreten ist	Es ist ein schwerer Fehler aufgetreten. Bitte rufe die Aufsichtsperson und beschreibe das Problem!
booklet_msgPresentationNotCompleteTextNext	Nachrichttext, dass nicht weitergeblättert werden kann, solange die Präsentation des Aufgabeninhaltes nicht abgeschlossen ist	Du kannst erst weiterblättern, wenn Audio-Dateien vollständig abgespielt wurden und wenn du in allen Fenstern bis ganz nach unten gescrollt hast.
booklet_msgPresentationNotCompleteTextPrev	Nachrichttext, dass nicht zurückgeblättert werden kann, solange die Präsentation des Aufgabeninhaltes nicht abgeschlossen ist	Eine Audio-Datei ist noch nicht bis zu Ende abgespielt oder Seiten wurden noch nicht vollständig gezeigt. Wenn du jetzt zurückblätterst, kannst Du später Audio-Dateien nicht nocheinmal starten.
booklet_msgPresentationNotCompleteTitleNext	Titel der Nachricht (Dialogbox), dass nicht weitergeblättert werden kann, solange die Präsentation des Aufgabeninhaltes nicht abgeschlossen ist	Weiterblättern nicht möglich!
booklet_msgPresentationNotCompleteTitlePrev	Titel der Nachricht (Dialogbox), dass nicht zurückgeblättert werden kann, solange die Präsentation des Aufgabeninhaltes nicht abgeschlossen ist	Zurückblättern - Warnung
booklet_msgSoonTimeOver1Minute	Nachricht, dass für die Bearbeitung eines Abschnittes noch 1 min Zeit ist	Du hast noch 1 Minute Zeit für die Bearbeitung der Aufgaben in diesem Abschnitt.
booklet_msgSoonTimeOver5Minutes	Nachricht, dass für die Bearbeitung eines Abschnittes noch 5 min Zeit sind	Du hast noch 5 Minuten Zeit für die Bearbeitung der Aufgaben in diesem Abschnitt.
booklet_msgTimeOver	Nachricht, dass die Bearbeitungszeit für einen Abschnitt abgelaufen ist.	Die Bearbeitung des Abschnittes ist beendet.
booklet_msgTimerCancelled	Nachricht, dass die Bearbeitung eines Abschnittes mit Timer abgebrochen wurde	Die Bearbeitung des Abschnittes wurde abgebrochen.
booklet_msgTimerStarted	Nachricht, dass der Timer für die Bearbeitung eines Abschnittes gestartet wurde	Die Bearbeitungszeit für diesen Abschnitt hat begonnen:
booklet_pausedmessage	Nachricht an die Testperson, wenn der Test vom System unterbrochen wurde	Der Test wurde kurz angehalten.
booklet_tasklisttitle	Titel für die Auflistung der Aufgaben (Schalter)	Aufgaben
booklet_warningLeaveTimerBlockTextPrompt	Schalterbeschriftung für 'Zurück zum Test'	Du verlässt einen zeitbeschränkten Bereich und kannst nicht zurückkehren. Trotzdem weiterblättern?
booklet_warningLeaveTimerBlockTitle	Titel für Warnung (Dialogbox) vor dem vorzeitigen Verlassen eines Abschnittes mit Timer	Aufgabenabschnitt verlassen?
login_bookletSelectPromptMany	Aufforderung, aus der Liste der gefundenen Tests einen auszusuchen (auf Schalter klicken)	Bitte klicke auf eine der Schaltflächen auf der linken Seite, um einen Test zu starten!
login_bookletSelectPromptNull	Nachricht für den Fall, dass Booklet(s) beendet wurden und keine weiteren zur Verfügung stehen	Beendet. Es können keine weiteren Testhefte gestartet werden.
login_bookletSelectPromptOne	Aufforderung, den einen gefundenen Test anzuklicken (auf Schalter klicken)	Bitte klicke auf die Schaltfläche auf der linken Seite, um den Test zu starten!
login_codeInputPrompt	Aufforderung, Code einzugeben (bei einem zweistufigen Login-Prozess)	Bitte Log-in eingeben, der auf dem Zettel steht!
login_codeInputTitle	Titel des Eingabeformulares für den Code	Log-in eingeben
login_testEndButtonLabel	Schalterbeschriftung für 'Test beenden'	Test beenden
syscheck_intro	Text auf der ersten Seite des System-Checks	Dieser Systemcheck soll gewährleisten, dass der von Ihnen verwendete Computer für eine bestimmte Befragung oder Testung geeignet ist.
syscheck_questionsRequiredMessage	Nachricht an die Testperson, wenn einige Fragen, die als 'required' markiert sind, nicht beantwortet wurden	Bitte prüfen Sie die Eingaben (unvollständig):
syscheck_questionsintro	Aufforderung, die Fragen (Questionnaire) zu beantworten	Bitte bearbeiten Sie die nachfolgenden Fragen.
syscheck_unitPrompt	Titelzeile über der Aufgabe	Bitte prüfen Sie die folgenden Aufgaben-Elemente