diff --git a/README.md b/README.md index 03b4617..01655cd 100644 --- a/README.md +++ b/README.md @@ -8,4 +8,34 @@ Diese Anwendung passt eine OSC-Datei so an, dass (standortbezogene) Formularvari verwendet werden. Hierzu wird die Datei deserialisiert, die entsprechenden Formularfelder ermittelt und die Formularvariante -sowie die Anzeige anhand eines Profils angepasst. \ No newline at end of file +sowie die Anzeige anhand eines Profils angepasst. + +## Profile + +Zum Erstellen von Varianten einer OSC-Datei wird eine Profildatei im YAML-Format verwendet. + +In ihr sind die durchzuführenden Änderungen definiert. Eine Profildatei hat die folgende Form: + +``` +forms: + - name: "ExampleForm" + fields: + - name: "ref_first_mtb" + referenced_data_form: "Formularverweis.Variante" + anzeige_auswahl: "Referenziertes Formular vom: {Datum}" + anzeige: "Datum im referenzierten Formular: {Datum}" +``` + +Hierzu wird die Anwendung angewiesen im Formular "ExampleForm" den Formularverweis im Formularfeld "ref_first_mtb": + +* den Verweis auf das Formular "Formularverweis.Variante" zu setzen +* die Anzeige im Auswahlmenü auf "Referenziertes Formular vom: {Datum}" zu setzen +* die Anzeige unterhalb des Auswahlmenüs auf "Datum im referenzierten Formular: {Datum}" zu setzen + +und dabei die vorhandenen Angaben für den Formularverweis zu ersetzen. + +Die Angaben für `referenced_data_form`, `anzeige_auswahl` und `anzeige` sind optional. +Wird keine Angabe gemacht, wird der bestehende Wert beibehalten. + +Es können beliebig viele Formulare mit beliebig vielen Änderungen zu Formularverweisen in einer Profildatei +hinterlegt werden, jedoch ist mindestens eine Angabe zu einem Formularfeld erforderlich. diff --git a/src/profile.rs b/src/profile.rs index 2b00018..ef69994 100644 --- a/src/profile.rs +++ b/src/profile.rs @@ -22,12 +22,12 @@ * SOFTWARE. */ -use std::str::FromStr; use serde::Deserialize; +use std::str::FromStr; #[derive(Deserialize)] struct Profile { - forms: Vec