====== option() ======

''void **option**(string //Option//, mixed //Einstellung//)''

Mit ''option()'' kann das Aussehen einer Seite im Fragebogen verändert werden. Den Befehl ''option()'' platzieren Sie einfach mittels [[:de:create:php|PHP-Code]] auf jener Seite des Fragebogens, deren Erscheinungsbild modifiziert werden soll. Folgende //Optionen// und mögliche -- je nach Option unterschiedliche -- //Einstellungen// stehen zur Verfügung:

  * '''progress''' -- Fortschrittsbalken anpassen
    * '''no''' -- Fortschrittsbalken ausblenden
    * '''yes''' -- Fortschrittsbalken anzeigen (wenn es für den Fragebogen deaktiviert wurde)
    * ''0'' bis ''100'' -- einen Fortschritt von genau so vielen Prozent anzeigen
  * '''progress.last''' -- Festlegen, auf welcher Seite der Fortschrittsbalken 100% erreicht (Standard: "end")
    * Text (string) -- Fragebogen-Seite ([[:de:glossary#seitenkennung|Seitenkennung]]) auf welcher 100% erreicht sind
  * '''nextbutton''' -- "Weiter"-Knopf
    * Text (string) -- Auf dem Weiter-Knopf diesen Text anzeigen
    * ''false'' - Den Weiter-Knopf auf der aktuellen Seite ausblenden
  * '''backbutton''' -- Zurück-Knopf
  * '''breakbutton''' -- Knopf zum Unterbrechen des Interviews
  * '''leavebutton''' -- Knopf zum Abbrechen und Löschen des Interviews
    * ''false'' -- Den entsprechenden Knopf ausblenden (falls er in den Fragebogen-Einstellungen aktiviert wurde)
    * ''true'' -- Den entsprechenden Knopf anzeigen (falls in den Fragebogen-Einstellungen nicht aktiviert)
    * Text (string) -- Den Knopf mit dem angegeben Text anzeigen
  * '''langbutton''' -- Knöpfe zur Sprachauswahl während des Interviews
    * ''false'' -- Knöpfe ausblenden (falls sie in den Fragebogen-Einstellungen aktiviert wurden)
    * ''true'' -- Knöpfe anzeigen (falls sie in den Fragebogen-Einstellungen nicht aktiviert wurden)
  * '''layout''' -- Für die aktuelle Fragebogen-Seite ein anderes Layout verwenden
    * Kennung (string) -- Die Kennung des Layouts, welches für die Seite verwendet werden soll
  * ''%%'resume'%%'' -- Hinweis unterdrücken, dass das Interview nach einer Unterbrechung fortgesetzt wird
    * ''true'' -- Hinweis unterdrücken, weil erwartet wird, dass das Interview hier fortgesetzt wird
    * ''false'' -- Hinweis anzeigen (Standardeinstellung)
  * ''%%'warn.leave'%%'' -- Warnung anzeigen/unterdrücken, wenn der Teilnehmer das Browserfenster schließt \\ Diese Einstellung entspricht der Auswahloption **Fragebogen zusammenstellen** -> //Einstellungen// -> "Warnung bei Verwendung des Browser-Zurück-Knopfes oder Schließen des Fensters"
    * ''true'' -- Hinweis anzeigen (falls vom Browser unterstützt)
    * ''false'' -- Hinweis deaktivieren
  * ''%%'probing'%%'' -- Die aktuelle Seite aus der Zurück-Historie herausnehmen\\ Wenn Sie eine zusätzliche Seite verwenden, um bei fehlender Antwort nachzuhaken und zugleich einen Zurück-Knopf erlauben, können Sie mit dieser Einstellung festlegen, dass der Teilnehmer die zusätzliche Seite beim "Zurück" überspringt.
  * '''part''' -- Den Start eines neuen Fragebogen-Anschnitts für die Druckansicht festlegen, s. ''[[:/de:create:functions:answersprint]]''
    * Text (string) -- Beliebige Bezeichnung des Abschnitts
  * ''%%'questionNumber'%%'' -- Die automatische Nummerierung der Fragen mit der angegeben Nummer fortsetzen.
    * Zahl (integer) -- Nummer ≥ 1
  * ''%%'speech.speed'%%'' -- Sprachausgabe (Text to Speech) aktivieren und/oder eine Geschwindigkeit einstellen.
    * Zahl (integer) -- 0 = Sprachausgabe deaktivieren, 1-4 = Sprachausgabe mit Geschwindigkeit 1 bis 4 aktivieren.


**Wichtig:** Der Befehl ''option()'' eignet sich nur, um die Beschriftung der Knöpfe auf __einzelnen__ Seite zu verändern. Wenn Sie die Beschriftung generell verändern möchten, dann legen Sie diese unter **Textbausteine und Beschriftung** fest ([[:de:create:stuff#weiter-knopf_beschriften|Anleitung für Standard-Aufgaben]]).

**Wichtig:** Wenn Sie generell keinen Fortschrittsbalken anzeigen möchten, dann deaktivieren Sie diesen unter **Fragebogen zusammenstellen** -> //Einstellungen// -> //Fortschrittsbalken anzeigen//.

**Hinweis:** Die Option '''resume''' ist hilfreich, wenn man die Befragung an einer Stelle absichtlich unterbrechen will -- z.B. zur Durchführung mehrerer Befragungswellen im selben Fragebogen (''[[:de:create:functions:buttonhide|buttonHide()]]''). Die Option muss gesetzt werden, bevor der Teilnehmer das Interview unterbricht, also z.B. gleich zu Beginn der Seite. Eine gezielte Unterbrechung kann man durch Ausblenden des Weiter-Knopfes mittels ''%%option("nextbutton", false)%%'' erzielen.

===== Fortschrittsbalken =====

Folgender PHP-Code sorgt dafür, dass der Fortschrittsbalken auf einer einzelnen Seite (z.B. auf der Begrüßungsseite) ausgeblendet wird:

<code php>
option('progress', 'no');
</code>

Auch eine Anpassung des angezeigten Fortschritts ist möglich. Wird der folgende PHP-Code auf einer Fragebogen-Seite platziert, wird auf der Seite ein Fortschritt von 30% angezeigt.

Ab Version 2.5.00 wird der Fortschritt auf nachfolgenden Seiten auf Basis des gesetzten Wertes berechnet. In älteren Programmversionen muss der Fortschritt ggf. für jede Seite einzeln eingestellt werden. Für vorhergehende Seiten muss der Fortschritt generell einzeln eingestellt werden, z.B. wenn der Fortschrittsbalken zu Beginn "langsamer" laufen soll.

<code php>
option('progress', 30);
</code>

===== Knöpfe im Fragebogen =====

Mit folgendem PHP-Code wird der Zurück-Knopf für eine einzelne Seite ausgeblendet (sofern er im Fragebogen generell eingeschaltet ist):

<code php>
option('backbutton', false);
</code>

Wenn Zurück-Knöpfe im Fragebogen generell ausgeschaltet sind, kann man sie wiederum für einzelne Seiten einblenden:

<code php>
option('backbutton', true);
</code>

Wird der folgende PHP-Code auf der vorletzten Seite im Fragebogen platziert, erhält der "Weiter"-Knopf die Beschriftung "Daten abschicken" und der "Zurück"-Knopf die Beschriftung "Angaben ändern".

<code php>
option('nextbutton', 'Daten abschicken');
option('backbutton', 'Angaben ändern');
</code>

===== Layout =====

Im Fragebogen soll ein großflächiger Stimulus angezeigt werden, der eine Website darstellt? Der "normale" Rahmen des Fragebogens ist dafür vermutlich zu schmal und stört das Erscheinungsbild.

Öffnen Sie den Menüpunkt **Fragebogen-Layouts**. Sollten Sie noch kein Layout aktiviert haben, aktivieren Sie zunächst unter //Layout-Vorlagen// das Layout "SoSci Survey Standard" (damit der Fragebogen weiterhin im Standard-Layout erscheint). Anschließend aktivieren Sie das Layout "SoSci Stimulus Presenter" -- es wird die Kennung "presenter" erhalten.

Verwenden Sie auf der Seite mit dem Stimulus nun folgenden PHP-Code, um den Rahmen des Fragebogens verschwinden zu lassen:

<code php>
option('layout', 'presenter');
</code>