Siduction Forum

BUGS => Manual / Handbuch => Topic started by: edlin on 2021/08/01, 18:29:09

Title: Ich fange mal an ...
Post by: edlin on 2021/08/01, 18:29:09
Zunächst mal ein großes Lob an alle Beteiligten. Ich hatte momentan nicht mit einem Manual/Handbuch in dieser Qualität gerechnet.
Auch finde ich den Verzicht auf unnötiges Gendern, zugunsten der Lesbarkeit, aus meiner Sicht als richtig.
Vorweg, auch ich bin kein Deutsch-Guru, es muss also nicht immer alles korrekt sein, was ich hier vorschlage. Auf inhaltliche Dinge lasse ich mich noch nicht ein, es ist also zunächst der Deutsch-Kram etc.
Ich habe die Version 2021-07-3 (Stand 27.07.2021) mal überflogen und ein paar Kleinigkeiten (auf den ersten Blick) gefunden:
    • S.10: „im PDF-Format, dass auf allen ISO’s und nach der Installation“
a) dass --> das      b)ISO’s --> ISO (Deppenapostroph)
    • S. 26: Überschrift in ISOs ändern; ISO’s in ISOs ändern
    • S. 28: ISO’s in ISOs ändern
    • S. 89: UUID’s in UUIDs ändern
    • S. 90: UUID’s in UUIDs ändern
    • S. 120: SSD’s in SSDs ändern
    • Und so weiter; mit Suchen/Ersetzen sollten die Deppenapostrophen schnell entfernt sein.
    • S. 138: Im roten Feld: Debian sollte als Eigenname einheitlich groß geschrieben.
„nicht möglich den NetworkManager“ --> „möglich, den“
    • S. 138: „machen wir darauf Aufmerksam“ --> „aufmerksam“
    • S. 200: „Generell ist anzumerken, das fast alle Grafikkarten“ das --> dass
    • S. 200: „Repository, das diese Firmware nict DFSG konform ist.“ nict --> nicht
Der Satz ist aber insgesamt etwas konfus und gehört neu formuliert
    • S. 204: „Überwachung von Documen-tRoot des Apache Webservers” an unglücklicher Stelle getrennt, DocumentRoot sollte nicht getrennt werden.
    • S. 209: „Farbe des Prompt ändern“ steht allein und gehört auf die neue Seite
    • S. 236: „drei Monate nicht zugewartet werden sollte.“
Hier war sicher gewartet gemeint.
    • S. 238: Im roten Feld: „kann zu Probleme führen“ --> „Problemen“
    • S. 238: „Zu beachten ist der folgende Ablauf:“ steht am Ende der Seite. Solche auf Doppelpunkt endenden Elemente sollten grundsätzlich an den Anfang der nächsten Seite gesetzt werden (tritt öfters im Handbuch auf).
    • S. 249: „ist sicher zu stellen, dass „ --> „sicherzustellen“
    • S. 251: „7.6 Systemd der System- und Dienste-Manager
Mein Vorschlag: Entweder „7.6 Systemd, der System- und Dienste-Manager“ oder „7.6 Der System- und Dienste-Manager Systemd“
    • S. 252: „7.6.2 Unit Typen“ wie im Text in „Unit-Typen“ ändern.

... to be continued.

edlin
Title: Re: Ich fange mal an ...
Post by: devil on 2021/08/03, 05:52:27
Vielen Dank, geh ich heute Abend gleich drüber.
Title: Re: Ich fange mal an ...
Post by: devil on 2021/08/03, 11:26:59
Btw.: Für uns ist es einfacher, wenn Du künftig die Kapitelnummern oder Kapitelüberschriften anstatt der Seitenzahlen nennst, denn letztere sind im Git nicht drin.

Edit: Ich hab jetzt mal das PDF zur Hand genommen und festgestellt, dass du das vermutlich nicht genutzt hast, da die Seitennummern nicht stimmen. Dürfte ich die bitten, das nochmal anhand der Kapitelnummern (oder Namen) zu referenzieren, dann kann ich das im Git anspringen und schnell finden.
Title: Re: Ich fange mal an ...
Post by: edlin on 2021/08/03, 12:54:19
Also ich hatte das Handbuch als PDF herangezogen.
Quelle:
Code: [Select]
/usr/share/siduction-manual/siduction-manual_de.pdf
Aber sei es drum, ich schreibe nochmal die Kapitelnummern dazu. Die Seitennummern werden sich bei Anpassungen ja eh immer etwas verschieben.

edlin
Title: Re: Ich fange mal an ...
Post by: devil on 2021/08/03, 15:42:05
Danke, es ist so viel einfacher, ich kann direkt im Git arbeiten und muss nicht das PDF dazwischenschalten.
Title: Re: Ich fange mal an ...
Post by: edlin on 2021/08/05, 12:36:26
Neuer Anlauf, auch wenns gedauert hat.
Basis ist (für mich) die Version 2021-07-3 (Stand 27.07.2021) als PDF.

Hier nochmal der Versuch mit Angabe der Kapitel.
    • Generell sollten alle „Deppenapostrophen“ entfernt werden. Diese sollten mittels Suchen & Ersetzen gefunden und ersetzt werden können. Daher hier nur die ersten Beispiele, die mir ins Auge stachen.
    • 1.0.1 Allgemeines: „im PDF-Format, dass auf allen ISO’s und nach der Installation“
ISO’s --> ISO
    • 3 ISO s: Überschrift in ISOs ändern; ISO’s in ISOs ändern
    • 3.1.2 Varianten der ISO: Titel in „Varianten der ISOs“ ändern
Im letzten Absatz ISO’s in ISOs ändern
    • Anmerkung: Gerade in Überschriften oder einführenden Texten könnte man auch von ISO-Abbildern, ISO-Dateien oder Datenträgerabbildern sprechen. Im weiteren Text würde ich auch die Kurzform ISO bzw. Plural ISOs verwenden.
    • 4.7.3 fstab anpassen: UUID’s in UUIDs ändern (2x)
    • 4.10 LVM-Partitionierung - Logical Volume Manager: SSD’s in SSDs ändern (2x).
    • 5.2.1 IWD installieren: Im roten Feld:
       - Debian sollte als Eigenname einheitlich groß geschrieben werden.
       - „nicht möglich den NetworkManager“ --> „möglich, den“
       - „machen wir darauf Aufmerksam“ --> „aufmerksam“
    • a) 10.0.1 Allgemeines: a) dass --> das
    • 6.1.4 3D Treiber: „Generell ist anzumerken, das fast alle Grafikkarten“ das --> dass
    • dto: „Repository, das diese Firmware nict DFSG konform ist.“ nict --> nicht
Der Satz ist aber insgesamt etwas konfus und gehört neu formuliert.
    • 7 Systemadministration: „Überwachung von Documen-tRoot des Apache Webservers” an unglücklicher Stelle getrennt, DocumentRoot sollte nicht getrennt werden.
    • 7.1.2 Farbiges Terminal: „Farbe des Prompt ändern“ steht (zumindest in meinem PDF) allein in der letzten Zeile und gehört auf die neue Seiten (sogenannter Schusterjunge).
    • 7.3.7 Aktualisierung des Systems: „drei Monate nicht zugewartet werden sollte.“
Hier war sicher gewartet gemeint.
    • 7.3.9 full-upgrade ausführen: Im roten Feld: „kann zu Probleme führen“ --> „Problemen“
    • dto: „Zu beachten ist der folgende Ablauf:“ steht (in meinem PDF) am Ende der Seite. Schusterjunge -> An den Anfang der nächsten Seite setzen.
    • 7.5.2 Module: „ist sicher zu stellen, dass „ --> „sicherzustellen“
    • 7.6 Systemd der System- und Dienste-Manager: „7.6 Systemd der System- und Dienste-Manager
Mein Vorschlag: Entweder „7.6 Systemd, der System- und Dienste-Manager“ oder „7.6 Der System- und Dienste-Manager Systemd“
    • 7.6.2 Unit Typen: „7.6.2 Unit Typen“ wie im Text in „Unit-Typen“ ändern.
 
Schusterjungen und Hurenkinder lassen sich nicht immer 100%ig verhindern. Falls ihr mit LaTeX arbeitet, könnt ihr mal den folgenden Eintrag testen:
Code: [Select]
% Hurenkinder und Schusterjungen verhindern
\clubpenalty10000
\widowpenalty10000
\displaywidowpenalty=10000

edlin
Title: Re: Ich fange mal an ...
Post by: devil on 2021/08/05, 14:35:33
Danke für die Kapitelnummern, damit ist es nun einfach.
Title: Re: Ich fange mal an ...
Post by: hendrikL on 2021/08/05, 15:02:34
Code: [Select]
% Hurenkinder und Schusterjungen verhindern
\clubpenalty10000
\widowpenalty10000
\displaywidowpenalty=10000

Ich habe es mal eingebaut, mal schauen, wenn es dann so weit ist mit neuem/überarbeitetem Manual/Handbuch und dann hoffentlich auch in Englisch.

Code: [Select]
% Paragraphs (Hurenkinder und Schusterjungen verhindern)
\usepackage{indentfirst}
    \frenchspacing
\usepackage[nodisplayskipstretch]{setspace}
    \onehalfspacing
    \sloppy
    \clubpenalty10000
    \widowpenalty10000
    \displaywidowpenalty=10000

Damit habe ich das beste Ergebnis erzielt.

Danke für den Hinweis,

hendrikL

Ps.: Hier geht es zu den Sourcen, wer mithelfen möchte .... !
 https://github.com/siduction/sidu-manual & https://github.com/siduction/sidu-manual/wiki
Title: Re: Ich fange mal an ...
Post by: edlin on 2021/08/05, 16:56:15
Danke für die Links. Ich werde mal versuchen, immer mal an der Überarbeitung bzw. Verbesserung des deutschen Handbuches mitzuwirken. Allerdings gehöre ich (ungewollt) zur Gattung "Rentner haben niemals Zeit".

edlin
Title: Re: Ich fange mal an ...
Post by: hendrikL on 2021/08/05, 19:59:01
https://github.com/siduction/sidu-manual/issues/18