Kernkonzepte
Überblick über das Formulardesign
Was ist ein XLSForm?
rtSurvey verwendet eine erweiterte Version des XLSForm-Standards für das Formulardesign und bietet leistungsstarke Funktionen für die Erstellung anspruchsvoller Umfragen. Dieser Leitfaden führt Sie in die Kernkonzepte des Formulardesigns in rtSurvey ein, von der grundlegenden XLSForm-Struktur bis hin zu fortgeschrittenen rtSurvey-spezifischen Funktionen.
Mit XLSForms können Sie Formulare in einem für Menschen lesbaren Format mit dem vertrauten Tool Excel erstellen, was es für fast jeden zugänglich macht. Dieser Standard ermöglicht den einfachen Austausch und die Zusammenarbeit bei der Formularerstellung.
XLSForms sind zwar einsteigerfreundlich, ermöglichen es aber auch erfahrenen Anwendern, komplexe Formulare zu erstellen.
rtSurvey bietet eine einheitliche Möglichkeit, erweiterte Funktionen wie die Übersprunglogik (skip logic) in Formulare auf verschiedenen webbasierten und mobilen Datenerfassungsplattformen zu integrieren.
XLSForm-Struktur
Ein XLSForm besteht normalerweise aus zwei Hauptarbeitsblättern:
- survey: Definiert die Struktur und den Inhalt Ihres Formulars.
- choices: Spezifiziert die Antwortmöglichkeiten für Multiple-Choice-Fragen.
Ein optionales Arbeitsblatt settings kann zusätzliche Formularspezifikationen enthalten.
Es ist wichtig zu beachten, dass die obligatorischen Spalten in den Arbeitsblättern survey und choices vorhanden sein müssen, damit das Formular ordnungsgemäß funktioniert. Optionale Spalten in beiden Arbeitsblättern bieten eine weitere Kontrolle über das Verhalten jedes Eintrags im Formular, sind aber nicht zwingend erforderlich.
Die Spalten in Ihrer Excel-Arbeitsmappe können in beliebiger Reihenfolge erscheinen, und optionale Spalten können leer gelassen werden. Es ist jedoch entscheidend, die genaue Syntax und die Namenskonventionen zu verwenden, die in der XLSForm-Dokumentation spezifiziert sind, damit das Formular korrekt funktioniert.
Das survey-Arbeitsblatt
Im survey-Arbeitsblatt definieren Sie die Struktur Ihres Formulars und stellen den Inhalt bereit. Jede Zeile im survey-Arbeitsblatt repräsentiert eine Frage oder ein Element in Ihrem Formular. Die folgenden Spalten sind im survey-Arbeitsblatt obligatorisch:
type: Gibt den Typ des Eintrags an, den Sie für die Frage erwarten.name: Gibt den eindeutigen Variablennamen für diesen Eintrag an. Namen müssen mit einem Buchstaben oder einem Unterstrich beginnen und dürfen nur Buchstaben, Ziffern, Bindestriche, Unterstriche und Punkte enthalten. Namen sind fallsensitiv.label: Enthält den eigentlichen Text, den Sie für die Frage im Formular sehen.
| type | name | label |
|---|---|---|
| today | today | |
| select_one gender | gender | Respondent’s gender? |
| integer | age | Respondent’s age? |
Das choices-Arbeitsblatt
Das Arbeitsblatt choices wird verwendet, um die Antwortmöglichkeiten für Multiple-Choice-Fragen anzugeben.
Jede Zeile repräsentiert eine Antwortmöglichkeit. Die folgenden Spalten sind im choices-Arbeitsblatt obligatorisch:
list_name: Gruppiert eine Reihe zusammengehöriger Antwortmöglichkeiten.name: Legt den eindeutigen Variablennamen für diese Antwortmöglichkeit fest.label: Zeigt die Antwortmöglichkeit genau so an, wie sie im Formular erscheinen soll.
| list_name | name | label |
|---|---|---|
| gender | transgender | Transgender |
| gender | female | Female |
| gender | male | Male |
| gender | other | Other |
Die Spalten, die Sie Ihrer Excel-Arbeitsmappe hinzufügen, ob obligatorisch oder optional, können in beliebiger Reihenfolge erscheinen. Optionale Spalten können ganz weggelassen werden. Zeilen oder Spalten können zur besseren Lesbarkeit leer gelassen werden, aber Daten nach 20 nebeneinander liegenden leeren Spalten oder Zeilen auf einem Blatt werden nicht verarbeitet. Die gesamte Textformatierung der .xlsx-Datei wird ignoriert, sodass Sie Trennlinien, Schattierungen und andere Schriftformatierungen verwenden können, um das Formular lesbarer zu machen.
Eine Sache, die Sie bei der Erstellung von Formularen in Excel beachten sollten, ist, dass die Syntax präzise sein muss. Wenn Sie zum Beispiel Choices oder choice statt choices schreiben, wird das Formular nicht funktionieren.
Das settings-Arbeitsblatt
Das settings-Arbeitsblatt ist optional, ermöglicht es Ihnen jedoch, Metadaten und Verhalten auf Formularebene festzulegen. Häufige Spalten im settings-Arbeitsblatt sind:
| Spalte | Beschreibung |
|---|---|
| form_title | Der Titel des Formulars, wie er den Benutzern erscheint |
| form_id | Eine eindeutige Kennung für das Formular, die in der Datenverwaltung und bei API-Aufrufen verwendet wird |
| default_language | Der Standard-Sprachcode für mehrsprachige Formulare (z. B. ‘de’ für Deutsch) |
| version | Die Versionsnummer des Formulars, nützlich für die Verfolgung von Änderungen |
| instance_name | Ausdruck zur Generierung eines eindeutigen Namens für jede Formularübermittlung |
| generation | Ganzzahl, die die Generation des Formulars markiert. Bei strukturellen Änderungen erhöhen |
| family | Kennung zur Gruppierung verwandter Formulare über strukturelle Änderungen hinweg |
Das settings-Arbeitsblatt in rtSurvey kann auch zusätzliche Konfigurationen für die erweiterten Funktionalitäten von rtSurvey enthalten. Informationen hierzu finden Sie in der rtSurvey-Dokumentation.
Kernkomponenten des survey-Arbeitsblatts
Das survey-Arbeitsblatt ist das Herzstück Ihres Formulardesigns. Hier ist ein Überblick über seine Kernkomponenten:
| Komponente | Beschreibung |
|---|---|
| type | Gibt den Fragetyp an (z. B. text, integer, select_one) |
| name | Eindeutige Kennung für die Frage |
| label | Der dem Befragten angezeigte Text |
| hint | Zusätzliche Hinweise für den Befragten |
| appearance | Modifiziert die Anzeige der Frage |
| relevant | Bestimmt, wann die Frage gestellt werden soll (Übersprunglogik) |
| constraint | Validiert die Antwort |
| calculation | Berechnet Werte basierend auf anderen Antworten |
| required | Gibt an, ob die Frage beantwortet werden muss |
Jede dieser Komponenten spielt eine entscheidende Rolle bei der Erstellung effektiver und effizienter Umfragen. Klicken Sie auf die Links in der Spalte “Komponente”, um mehr über die einzelnen Elemente zu erfahren.
Fragetypen
XLSForm unterstützt eine Reihe von Fragetypen. Dies sind nur einige der Optionen, die Sie in der Spalte type im Arbeitsblatt survey Ihres XLSForm eingeben können:
| Fragetyp | Antwort-Eingabe |
|---|---|
| integer | Ganzzahl-Eingabe. |
| decimal | Dezimalzahl-Eingabe. |
| range | Bereichs-Eingabe (einschließlich Bewertung). |
| text | Freitext-Antwort. |
| select_one [options] | Multiple-Choice-Frage; nur eine Antwort kann ausgewählt werden. |
| select_multiple [options] | Multiple-Choice-Frage; mehrere Antworten können ausgewählt werden. |
| select_one_from_file [file] | Multiple Choice aus Datei; nur eine Antwort wählbar. |
| select_multiple_from_file [file] | Multiple Choice aus Datei; mehrere Antworten wählbar. |
| rank [options] | Rank-Frage; eine Liste ordnen. |
| note | Zeigt einen Hinweis auf dem Bildschirm an, benötigt keine Eingabe. Kurzform für type=text mit readonly=true. |
| geopoint | Erfassung einer einzelnen GPS-Koordinate. |
| geotrace | Aufzeichnung einer Linie aus zwei oder mehr GPS-Koordinaten. |
| geoshape | Aufzeichnung eines Polygons aus mehreren GPS-Koordinaten; der letzte Punkt entspricht dem ersten. |
| date | Datumseingabe. |
| time | Zeiteingabe. |
| dateTime | Akzeptiert eine Datums- und Zeiteingabe. |
| image | Foto aufnehmen oder eine Bilddatei hochladen. |
| audio | Audioaufnahme machen oder eine Audiodatei hochladen. |
| background-audio | Audio wird im Hintergrund aufgezeichnet, während das Formular ausgefüllt wird. |
| video | Videoaufnahme machen oder eine Videodatei hochladen. |
| file | Allgemeine Dateieingabe (txt, pdf, xls, xlsx, doc, docx, rtf, zip). |
| barcode | Barcode scannen, erfordert die Installation der Barcode-Scanner-App. |
| calculate | Berechnung durchführen; siehe Abschnitt Berechnung unten. |
| acknowledge | Bestätigungsaufforderung, die den Wert auf “OK” setzt, wenn sie ausgewählt wird. |
| hidden | Ein Feld ohne zugehöriges UI-Element, das zum Speichern einer Konstante verwendet werden kann. |
| xml-external | Fügt einen Verweis auf eine externe XML-Datenquelle hinzu. |
Beschriftungen (Labels)
Beschriftungen sind der Text, der den Befragten für jede Frage angezeigt wird. Sie sind entscheidend für eine klare Kommunikation in Umfragen.
- Grundlegende Verwendung: Geben Sie in der Spalte
labelden Fragetext ein. - Mehrere Sprachen: Verwenden Sie zusätzliche Spalten wie
label::Englishundlabel::Deutschfür mehrsprachige Umfragen. - Formatierung: rtSurvey unterstützt grundlegende HTML-Formatierung in Beschriftungen zur Hervorhebung oder Strukturierung.
Beispiel:
| type | name | label | label::Deutsch |
|------|------|-------|---------------|
| text | name | What is your name? | Wie heißen Sie? |
Hinweise (Hints)
Hinweise bieten den Befragten zusätzliche Orientierung, ohne den Hauptfragetext zu überfrachten.
- Verwendung: Fügen Sie Hinweise in der Spalte
hinthinzu. - Sichtbarkeit: Hinweise werden normalerweise unter dem Hauptfragetext angezeigt.
- Mehrsprachig: Wie Beschriftungen können auch Hinweise für mehrere Sprachen über
hint::Sprache-Spalten festgelegt werden.
Beispiel:
| type | name | label | hint |
|------|------|-------|------|
| integer | age | Wie alt sind Sie? | Bitte geben Sie Ihr Alter in Jahren an |
Erscheinungsbild (Appearance)
Die Spalte appearance in rtSurvey ermöglicht es, die Anzeige von Fragen anzupassen.
- Standardoptionen: Umfassen ‘multiline’ für Text, ‘horizontal’ für Auswahlfragen.
- rtSurvey-Erweiterungen:
- Zeiteingabe: Verschiedene Uhr-Anzeigeoptionen (z. B.
inline,inline-1line) - Farbanpassung: Verwenden Sie die Funktion
colors(), um Symbolfarben zu ändern
- Zeiteingabe: Verschiedene Uhr-Anzeigeoptionen (z. B.
Beispiel:
| type | name | label | appearance |
|------|------|-------|------------|
| text | time | Zeit eingeben | inline-[%H:%M] |
Relevanz (Relevant)
Die Spalte relevant implementiert die Übersprunglogik und bestimmt, wann eine Frage angezeigt werden soll.
- Syntax: Verwenden Sie XPath-Ausdrücke, um Bedingungen zu definieren.
- Variablen: Verweisen Sie auf andere Fragennamen mit
${fragenname}.
Beispiel:
| type | name | label | relevant |
|------|------|-------|----------|
| text | allergies | Allergien auflisten | ${hat_allergien} = 'yes' |
Erforderlich (Required)
Die Spalte required gibt an, ob eine Frage beantwortet werden muss.
- Grundlegende Verwendung: Verwenden Sie ‘yes’ oder ’true’, um eine Frage zu einem Pflichtfeld zu machen.
- Erweitert: Kann Ausdrücke für bedingte Anforderungen verwenden.
Beispiel:
| type | name | label | required |
|------|------|-------|----------|
| text | email | E-Mail-Adresse | yes |
Wiederholungen (Repeats)
Wiederholungen ermöglichen es, eine Gruppe von Fragen mehrmals zu beantworten.
- Verwendung: Verwenden Sie die Zeilen
begin repeatundend repeat, um eine Wiederholungsgruppe zu definieren. - Benennung: Geben Sie jeder Wiederholungsgruppe einen eindeutigen Namen.
Beispiel:
| type | name | label |
|------|------|-------|
| begin repeat | haushaltsmitglied | Haushaltsmitglied |
| text | name_mitglied | Name |
| integer | alter_mitglied | Alter |
| end repeat | | |
Medien (Media)
rtSurvey unterstützt verschiedene Medientypen in Umfragen, einschließlich Bildern, Audio und Video.
- Fragetypen: Verwenden Sie ‘image’, ‘audio’ oder ‘video’ in der Typspalte.
- Medien in Beschriftungen: Verweisen Sie mit HTML-Tags auf Mediendateien in Beschriftungen.
Beispiel:
| type | name | label |
|------|------|-------|
| image | haus_foto | Machen Sie ein Foto vom Haus |
| note | | <img src="logo.jpg" /> Willkommen zur Umfrage |
Nur Lesezugriff (Read-only)
Nur-Lese-Fragen zeigen Informationen an, ohne eine Benutzereingabe zu ermöglichen.
- Verwendung: Fügen Sie ‘readonly’ in der Spalte
appearancehinzu oder nutzen Sie die Spalteread_only. - Berechnungen: Wird oft mit dem Typ calculate verwendet, um berechnete Werte anzuzeigen.
Beispiel:
| type | name | label | appearance | calculation |
|-----------|------|-------|------------|-------------|
| calculate | bmi | BMI | readonly | ${gewicht} / (${groesse} * ${groesse}) |
rtSurvey-Erweiterungen
rtSurvey erweitert den XLSForm-Standard durch die Unterstützung zusätzlicher Funktionen wie Grid-Layout, HTML-Format und viele neue Widgets.
Grid-Layout
rtSurvey ermöglicht es Ihrem Formular, das Aussehen traditioneller Papierumfragen nachzuahmen, indem mehrere Fragen in einer Zeile zusammengefasst werden.