diff --git a/.gitignore b/.gitignore index 6768b44..08fc2d7 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,6 @@ test.png # pip install -e . cusy_design_system.egg-info/ + +#vale +styles/* diff --git a/.vale.ini b/.vale.ini index b9f011a..25e4f70 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,5 +1,8 @@ -StylesPath = ./docs/.vale +StylesPath = styles MinAlertLevel = suggestion +Packages = https://github.com/cusyio/cusy-vale/archive/refs/tags/v0.1.0.zip + [*.{md,rst}] -BasedOnStyles = cusy +TokenIgnores = (:linenos:) +BasedOnStyles = cusy-de diff --git a/docs/viz/diagram-anatomy/legends.rst b/docs/viz/diagram-anatomy/legends.rst index d7ca460..305b3e6 100644 --- a/docs/viz/diagram-anatomy/legends.rst +++ b/docs/viz/diagram-anatomy/legends.rst @@ -122,10 +122,11 @@ und die Legende wird auf ihren Standardzustand zurückgesetzt. Versteckte Legenden ~~~~~~~~~~~~~~~~~~~ -Bitte beachtet, dass sich das Ausblenden von Legenden in Datenvisualisierungen -nur sehr selten empfiehlt, es sei denn, es wird nur eine Datenkategorie -angezeigt. Dieses Design ist für kleine mobile Displays gedacht, bei denen -Legenden den Blick auf die Datenvisualisierung versperren würde. +.. note:: + Das Ausblenden von Legenden in Datenvisualisierungen empfiehlt sich nur sehr + selten, es sei denn, es wird nur eine Datenkategorie angezeigt. Dieses Design + ist für kleine mobile Displays gedacht, bei denen Legenden den Blick auf die + Datenvisualisierung versperren würde. .. figure:: legends-hidden-1.png :alt: Auf dem Handy versteckte Legenden diff --git a/docs/writing/voice-tone.rst b/docs/writing/voice-tone.rst index 2b6fbd9..58d79aa 100644 --- a/docs/writing/voice-tone.rst +++ b/docs/writing/voice-tone.rst @@ -25,6 +25,8 @@ euer Text vielleicht in andere Sprachen übersetzt wird. Was ihr vermeiden solltet ------------------------- +.. vale off + * Buzzwords oder Fachjargon * niedlich oder albern sein wollen * aktuelle popkulturelle Anspielungen @@ -39,8 +41,11 @@ Was ihr vermeiden solltet * Vereinnahmende Formulierungen wie *Lasst uns das machen*. * Die Verwendung von Ausdrücken wie *einfach*, *es ist so einfach* oder *schnell* -* Internet-Slang oder -Abkürzungen wie :abbr:`tl;dr (Too long; didn’t read)` oder - :abbr:`ymmv (englisch: Je nach dem, wie weit ihr geht, kann das variieren)` +* Internet-Slang oder -Abkürzungen wie :abbr:`tl;dr (Too long; didn’t read)` + oder :abbr:`ymmv (englisch: Je nach dem, wie weit ihr geht, kann das + variieren)` + +.. vale on Was ihr berücksichtigen solltet ------------------------------- @@ -66,6 +71,8 @@ Was ihr berücksichtigen solltet Seid höfflich ------------- +.. vale off + Es ist schön, höflich zu sein, aber die Verwendung von *bitte* in einer Anweisung ist übertrieben. @@ -74,6 +81,8 @@ Anweisung ist übertrieben. * ✅ Weitere Informationen finden Sie unter … * ❌ Für weitere Informationen klickt bitte auf … +.. vale on + Beispiele --------- diff --git a/docs/writing/writing-style.rst b/docs/writing/writing-style.rst index 3e5f187..f620e2e 100644 --- a/docs/writing/writing-style.rst +++ b/docs/writing/writing-style.rst @@ -53,6 +53,8 @@ Einfaches Schreiben Verwendet einfache Wörter und Sätze ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. vale off + * Verwendet den einfachsten Begriff, der für das Publikum geeignet ist. Verwendet beispielsweise *groß* statt *voluminös* und *klein* anstelle von *Diminutiv*. @@ -64,6 +66,8 @@ Verwendet einfache Wörter und Sätze da sie in manchen kulturellen Kontexten unangemessen oder beleidigend sein könnten. +.. vale on + .. note:: Erstellt eine Liste mit Wörtern für euer Thema, die sowohl bevorzugte wie auch nicht zu verwendende Wörter enthält. Dieses einfache Werkzeug kann im Laufe der Zeit zur diff --git a/pyproject.toml b/pyproject.toml index 8b4cc93..5314165 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,6 +25,7 @@ docs = [ dev = [ "cusy-design-system[docs]", "pre-commit", + "vale", ] [project.urls] diff --git a/styles/.gitignore b/styles/.gitignore new file mode 100644 index 0000000..888cace --- /dev/null +++ b/styles/.gitignore @@ -0,0 +1,3 @@ +# ignore everything except .gitignore +* +!.gitignore