From 85fcb3a93961ab1825adeb05b66adffb0e281897 Mon Sep 17 00:00:00 2001 From: Nico Wagner Date: Tue, 18 Jul 2023 08:29:38 +0200 Subject: [PATCH] Revise `invalid` docs --- docs/book.bak/src/de/guide/cmds/invalid.md | 25 ------------------ docs/book/custom.css | 6 +++++ docs/book/src/SUMMARY.md | 1 + docs/book/src/referenz/kommandos/index.md | 1 + docs/book/src/referenz/kommandos/invalid.md | 29 +++++++++++++++++++++ pica-toolkit/tests/snapshot.rs | 3 ++- 6 files changed, 39 insertions(+), 26 deletions(-) delete mode 100644 docs/book.bak/src/de/guide/cmds/invalid.md create mode 100644 docs/book/src/referenz/kommandos/invalid.md diff --git a/docs/book.bak/src/de/guide/cmds/invalid.md b/docs/book.bak/src/de/guide/cmds/invalid.md deleted file mode 100644 index 4f2447da4..000000000 --- a/docs/book.bak/src/de/guide/cmds/invalid.md +++ /dev/null @@ -1,25 +0,0 @@ -# invalid - -Das Kommando `invalid` filtert aus einer Datei Zeilen heraus, die nicht -dekodiert werden konnten und somit ungültig sind. - -## Beschreibung - -Bei der Verarbeitung von PICA-Daten kann es vorkommen, dass Zeilen in -der Eingabe(-datei) nicht dekodiert werden können. Diese ungültigen Zeilen -lassen sich bei den vielen Kommandos mit der Option `--skip-invalid` (bzw. -`-s`) überspringen, wobei die Anzahl der übersprungenen Zeilen nicht -angezeigt wird. Es kann aber empfehlenswert oder notwendig sein, die Anzahl -invalider Datensätze zu kontrollieren und einer Prüfung zu unterziehen, um -diese ggf. zu korrigieren. - -Im folgenden Befehl werden alle ungültigen Datensätze aus der Datei -`DUMP.dat.gz` gefiltert und in die Datei `invalid.dat` geschrieben. - -```bash -$ pica invalid DUMP.dat.gz -o invalid.dat -``` - - - - diff --git a/docs/book/custom.css b/docs/book/custom.css index f643e5609..f51f8e9f8 100644 --- a/docs/book/custom.css +++ b/docs/book/custom.css @@ -1,3 +1,9 @@ +:root { + --content-max-width: 90%; + --sidebar-width: 230px; +} + + body { font-family: arial, sans-serif; } diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 615f5ceea..ba74e7324 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -15,3 +15,4 @@ - [completions](./referenz/kommandos/completions.md) - [count](./referenz/kommandos/count.md) - [frequency](./referenz/kommandos/frequency.md) + - [invalid](./referenz/kommandos/invalid.md) diff --git a/docs/book/src/referenz/kommandos/index.md b/docs/book/src/referenz/kommandos/index.md index 00c4f6d99..fabe6aae3 100644 --- a/docs/book/src/referenz/kommandos/index.md +++ b/docs/book/src/referenz/kommandos/index.md @@ -10,3 +10,4 @@ * [count](./count.md) — Zählen von Datensätzen, Felder und Unterfeldern * [frequency](./frequency.md) — Ermitteln einer Häufigkeitsverteilung über ein oder mehrere Unterfelder +* [invalid](./invalid.md) — Findet ungültige Zeilen in der Eingabe diff --git a/docs/book/src/referenz/kommandos/invalid.md b/docs/book/src/referenz/kommandos/invalid.md new file mode 100644 index 000000000..71656450e --- /dev/null +++ b/docs/book/src/referenz/kommandos/invalid.md @@ -0,0 +1,29 @@ +# invalid + +![stability-badge](https://img.shields.io/badge/stability-stable-green?style=flat-square) + +Das `invalid`-Kommando findet Zeilen in der Eingabe, die nicht als +normalisiertes PICA+ dekodiert werden konnten und somit ungültig sind. + +## Beschreibung + +Bei der Verarbeitung von PICA-Daten kann es vorkommen, dass Zeilen in +der Eingabe nicht dekodiert werden können. Diese ungültigen Zeilen +lassen sich bei vielen Kommandos mit der Option `--skip-invalid` (bzw. +`-s`) überspringen, wobei die Anzahl der übersprungenen Zeilen nicht +angezeigt wird. Es kann aber empfehlenswert oder notwendig sein, die +Anzahl invalider Datensätze zu kontrollieren und einer Prüfung zu +unterziehen, um diese ggf. zu korrigieren. + +Der folgende Befehl findet alle ungültigen Datensätze aus der Datei +`DUMP.dat.gz` und schreibt diese Zeile in die Datei `invalid.dat`: + +```console +$ pica invalid DUMP.dat.gz -o invalid.dat +``` + +## Optionen + +* `-o`, `--output` — Angabe, in welche Datei die Ausgabe geschrieben + werden soll. Standardmäßig wird die Ausgabe in die Standardausgabe + `stdout` geschrieben. diff --git a/pica-toolkit/tests/snapshot.rs b/pica-toolkit/tests/snapshot.rs index 980161394..7dd19826c 100644 --- a/pica-toolkit/tests/snapshot.rs +++ b/pica-toolkit/tests/snapshot.rs @@ -32,5 +32,6 @@ fn cli_tests() { #[test] fn doc_tests() { trycmd::TestCases::new() - .case("../docs/book/src/referenz/kommandos/frequency.md"); + .case("../docs/book/src/referenz/kommandos/frequency.md") + .case("../docs/book/src/referenz/kommandos/invalid.md"); }