diff --git a/docs/book/custom.css b/docs/book/custom.css index b997383fd..f643e5609 100644 --- a/docs/book/custom.css +++ b/docs/book/custom.css @@ -15,5 +15,5 @@ main h2, h3 { } .content ul li { - padding: 5px 0px; + /* padding: 5px 0px; */ } diff --git a/docs/book/src/README.md b/docs/book/src/README.md new file mode 100644 index 000000000..1d3396bd3 --- /dev/null +++ b/docs/book/src/README.md @@ -0,0 +1,26 @@ +# pica-rs + +[![CI](https://github.com/deutsche-nationalbibliothek/pica-rs/workflows/CI/badge.svg?branch=main)](https://github.com/deutsche-nationalbibliothek/pica-rs/actions?query=workflow%3ACI+branch%3Amain) +[![Documentation](https://img.shields.io/badge/Documentation-main-orange.svg)](https://deutsche-nationalbibliothek.github.io/pica-rs/) +[![dependency status](https://deps.rs/repo/github/deutsche-nationalbibliothek/pica-rs/status.svg)](https://deps.rs/repo/github/deutsche-nationalbibliothek/pica-rs) + +Das Toolkit _pica-rs_ ermöglicht eine effiziente Verarbeitung von +bibliografischen Metadaten, die in PICA+, dem internen Format des +[_OCLC_]-Katalogsystems, kodiert sind. Mit Hilfe verschiedener +[_Kommandos_] können aus den Metadaten elementare statistische Größen +ermittelt und aufbereitet werden. Zudem kann das Toolkit als +Brückentechnologie fungieren, um Metadaten für populäre Frameworks wie +[_Pandas_] oder [_Polars_] (Python), in Programmiersprachen wie [_R_] +oder für Excel nutzbar zu machen. Darüber hinaus eignet sich das Toolkit +für die Automatisierung von Metadaten-Workflows. + +## Verwandte Projekte + +- [Catmandu::Pica](https://metacpan.org/pod/Catmandu::PICA) — Catmandu modules for working with PICA+ data +- [Metafacture](https://github.com/metafacture) — Tool suite for metadata processing + +[_Kommandos_]: referenz/kommandos/index.md +[_OCLC_]: https://www.oclc.org/de/ +[_Pandas_]: https://pandas.pydata.org/ +[_Polars_]: https://www.pola.rs/ +[_R_]: https://www.r-project.org/ diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 8fd891826..d4b105e58 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -1,10 +1,13 @@ # Summary -- [Tutorials](./tutorials/index.md) +[Einführung](./README.md) -- [Anleitungen](./anleitungen/index.md) - - [Installation](./anleitungen/installation.md) + -- [Referenz](./referenz/index.md) - - [Kommandos](./referenz/kommandos/index.md) - - [cat](./referenz/kommandos/cat.md) +# Anleitungen + +- [Installation](./anleitungen/installation.md) + +# Referenz +- [Kommandos](./referenz/kommandos/index.md) + - [cat](./referenz/kommandos/cat.md) diff --git a/docs/book/src/referenz/kommandos/index.md b/docs/book/src/referenz/kommandos/index.md index d3db5f2db..d2ae7d6c9 100644 --- a/docs/book/src/referenz/kommandos/index.md +++ b/docs/book/src/referenz/kommandos/index.md @@ -1,7 +1,5 @@ # Kommandos -Das Programm `pica` (bzw. `pica.exe`) stellt über verschiedene Kommandos -Funktionen zur Verarbeitung von bibliographischen Datensätzen, die in -PICA+ kodiert sind, zur Verfügung. +## Übersicht -* [cat](./cat.md) — Zusammenfügen (konkatenieren) von Datensätzen +* [cat](./cat.md) — Zusammenfügen (Konkatenieren) von Datensätzen