Der Befehl wfyaml überprüft die Wohlgeformtheit eines oder mehrerer YAML-Dokumente gemäß der YAML 1.2-Spezifikation.
raptorxmlxbrl wfyaml [options] InputFile |
•Das Argument InputFile ist das YAML-Dokument, das auf Wohlgeformtheit überprüft werden soll.
•Um mehrere Dokumente zu überprüfen, (i) listen Sie entweder die zu überprüfenden Dateien im CLI auf, wobei jede Datei durch ein Leerzeichen von der nächsten getrennt wird, oder (ii) listen Sie die zu überprüfenden Dateien in einer Textdatei (.txt-Datei) auf (ein Dateiname pro Zeile) und geben Sie diese Textdatei zusammen mit der auf true gesetzten Option --listfile als das InputFile Argument an (siehe Optionsliste unten).
Beispiele
Beispiele für den Befehl wfyaml:
•raptorxmlxbrl wfyaml c:\MyYAMLFile.yaml
•raptorxmlxbrl wfyaml c:\MyYAMLFile-01.yaml c:\MyYAMLFile-02.yaml
•raptorxmlxbrl wfyaml --listfile=true c:\FileList.txt
RaptorXMLXBRL (und RaptorXMLXBRLServer für Administrator-Befehle) unter Windows raptorxmlxbrl und raptorxmlxbrlserver für Administrator-Befehle) unter Windows und Unix (Linux, Mac) * Beachten Sie, dass klein geschriebene Befehle (raptorxmlxbrl und raptorxmlxbrlserver) auf allen Plattformen (Windows, Linux und Mac) funktionieren, während großgeschriebene Befehle (RaptorXMLXBRL) nur unter Windows und Mac ausgeführt werden. *Verwenden Sie auf Linux und Mac-Systemen Schrägstriche und auf Windows-Systemen umgekehrte Schrägstriche. |
Auf Windows-Systemen: Verwenden Sie bei Vorhandensein von Leerzeichen oder Sonerzeichen in Strings (z.B. in Datei- oder Ordnernamen oder Firmen-, Personen- oder Produktnamen) Anführungszeichen: z.B., "Meine Datei". Beachten Sie jedoch, dass ein von einem doppelten Anführungszeichen gefolgter umgekehrter Schrägstrich (z.B: "C:\Mein Verzeichnis\") eventuell nicht korrekt gelesen wird, da der umgekehrte Schrägstrich auch den Beginn einer Escape-Sequenz markiert und die Escape-Sequenz \" für ein doppeltes Anführungszeichen steht. Wenn Sie diese Zeichensequenz mit einem Escape versehen wollen, verwenden Sie einen vorangestellten umgekehrten Schrägstrich, wie den folgenden: \\". Einfacher ausgedrückt: Wenn Sie einen Dateipfad, der Leerzeichen oder einen umgekehrten Schrägstrich am Ende enthält, schreiben müssen, so schreiben Sie diesen folgendermaßen: "C:\Mein Verzeichnis\\". |
Optionen
Optionen werden in ihrer kurzen Form (falls verfügbar) und in ihrer langen Form aufgelistet. Für die kurze und die lange Form können ein oder zwei Bindestriche verwendet werden. Eine Option kann, muss aber keinen Wert erhalten. Eine Option, die einen Wert erhält, wird folgendermaßen geschrieben: --option=wert. Werte können außer in zwei Fällen ohne Anführungszeichen definiert werden: (i) wenn der Wertestring Leerzeichen enthält oder (ii) wenn in der Beschreibung der Option explizit erwähnt ist, dass Anführungszeichen zwingend erforderlich sind. Wenn eine Option einen Booleschen Wert erhält und kein Wert definiert ist, so ist der Standardwert der Option TRUE. Mit Hilfe der Option --h, --help können Sie Informationen über den Befehl anzeigen.
--catalog = FILE Gibt den absoluten Pfad zu einer Root-Katalog-Datei an, die nicht die installierte Root-Katalog-Datei ist. Der Standardwert ist der absolute Pfad zur installierten Root-Katalog-Datei. (<installationsordner>\Altova\RaptorXMLXBRLServer2025\etc\RootCatalog.xml). Informationen zum Arbeiten mit Katalogen finden Sie im Abschnitt XML-Kataloge. |
--user-catalog = FILE Definiert den absoluten Pfad zu einem XML-Katalog, der zusätzlich zum Root-Katalog verwendet werden soll. Informationen zum Arbeiten mit Katalogen finden Sie im Abschnitt XML-Kataloge. |
--enable-globalresources = true|false Aktiviert die globalen Ressourcen. Standardwert ist false. Hinweis: Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird. |
|
--error-format = text|shortxml|longxml Definiert das Format der Fehlerausgabe. Der Standardwert ist text. Mit den anderen Optionen werden XML-Formate generiert, wobei mit longxml mehr Details generiert werden. |
--error-limit = N | unlimited Definiert das Fehlerlimit mit einem Wertebereich von 1 bis 9999 oder unbegrenzt. Der Standardwert ist 100. Bei Erreichung des Fehlerlimits wird die Validierung gestoppt. Dient dazu, die Prozessorverwendung während der Validierung/Transformation einzuschränken. |
--info-limit = N | unlimited Definiert die Grenze für Informationsmeldungen im Bereich von 1-65535 oder als unlimited (unbegrenzt). Die Verarbeitung wird auch nach Erreichen des Info-Limits fortgesetzt, doch werden weitere Meldungen nicht mehr ausgegeben. Der Standardwert ist 100. |
--help Zeigt den Hilfetext zum Befehl an. Beispiel: valany --h. (Alternativ dazu kann der Befehl help zusammen mit einem Argument verwendet werden. Beispiel: help valany.) |
--listfile = true|false Bei true wird das Argument InputFile des Befehls als Textdatei behandelt, die einen Dateinamen pro Zeile enthält. Der Standardwert ist false. (Als Alternative können die Dateien im CLI getrennt durch ein Leerzeichen aufgelistet werden. Beachten Sie allerdings, dass CLIs eine maximale Zeichenanzahl haben.) Beachten Sie, dass die Option --listfile nur auf Argumente, nicht aber auf Optionen angewendet wird. Hinweis: Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird. |
--log-output = FILE Schreibt die Meldungsausgabe in die angegebene URL. Stellen Sie sicher, dass das CLI Schreibrechte für den Ausgabepfad hat. |
--network-timeout = VALUE Definiert das Timeout für entfernte I/O-Operationen in Millisekunden. Der Standardwert ist: 40000. |
--recurse = true|false Dient zur Auswahl von Dateien innerhalb von Unterverzeichnissen einschließlich ZIP-Archiven. Bei true wählt das Argument InputFile des Befehls die angegebene Datei auch in den Unterverzeichnissen aus. Beispiel: "test.zip|zip\test.xml" wählt Dateien mit dem Namen test.xml auf allen Ordnerebenen des ZIP-Ordners aus. Referenzen auf ZIP-Dateien müssen in Anführungszeichen angegeben werden. Es können die Platzhalter * und ? verwendet werden. Mit *.xml werden folglich alle .xml Dateien im (ZIP-)Ordner ausgewählt. Der Standardwert der Option ist false. Hinweis: Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird. |
--verbose = true|false Mit dem Wert true wird die Ausgabe zusätzlicher Informationen bei der Validierung aktiviert. Der Standardwert ist false. Hinweis: Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird. |
--verbose-output = FILE Schreibt die ausführliche Ausgabe in FILE. |
--version Zeigt die Version von RaptorXML+XBRL Server an. Setzen Sie --version bei Verwendung mit einem Befehl vor den Befehl. |
--warning-limit = N | unlimited Definiert das Warnungslimit im Bereich von 1-65535 oder unbegrenzt. Bei Erreichen dieses Limits wird die Verarbeitung fortgesetzt, doch werden keine weiteren Warnungen mehr ausgegeben. Der Standardwert ist 100. |
|
