ubuntuusers.de

Wiki/Syntax

Status: Ungelöst | Ubuntu-Version: Nicht spezifiziert
Antworten |
Dieses Thema ist die Diskussion des Artikels Wiki/Syntax.

rklm Team-Icon

Projektleitung

Anmeldungsdatum:
16. Oktober 2011

Beiträge: 13320

cptechnik schrieb:

#beraschend ...😉

Ich schenke Dir noch ein "r".

linux_joy

Anmeldungsdatum:
6. Februar 2008

Beiträge: 803

Wohnort: Hannover

Hallo zusammen,

obwohl ich ja bereits öfter Fragen und Anregungen zur Textformatierung hatte (wie z.B. hier (ganz unten) und hier), so möchte ich es jetzt nochmal auf ein Neues probieren – hoffentlich erfolgreich:

Also: In Wiki/Syntax (Abschnitt „Textformatierung“) steht der folgende Satz:

Auch wenn Programme oft den gleichen Namen wie ein Paket haben, werden sie im Fließtext unformatiert gelassen.

Diesen hätte ich gerne umgeändert bzw. ergänzt zu:

Auch wenn Programme oft den gleichen Namen wie ein Paket haben, werden sie im Fließtext unformatiert gelassen, sofern es sich um GUI-Programme handelt. Terminal-Befehle hingegen werden dort in Monotype gesetzt.

Begründung: Die Monotype-Formatierung von Befehlen wird zwar in der vorstehenden Tabelle „Textformatierung“ erklärt (neben noch 6 anderen Verwendungs-Fällen, weswegen man sie leicht überlesen kann), nicht jedoch im nachstehenden Beispiel!

noisefloor Team-Icon

Anmeldungsdatum:
6. Juni 2006

Beiträge: 29567

Hallo,

? - das macht doch keinen Sinn... Das mit dem Terminalbefehl steht genau darüber in der Tabelle. Und Programmnamen sind Programmnamen - egal, ob das Programm mit TUI oder GUI läuft.

Was man machen könnte ist, die Tabelle darüber eine Zeile für unformatierten Text hinzuzufügen statt es in den Fließtext darunter zu schreiben.

Gruß, noisefloor

linux_joy

Anmeldungsdatum:
6. Februar 2008

Beiträge: 803

Wohnort: Hannover

Hallo noisefloor, Du schriebst:

Hallo,

? - das macht doch keinen Sinn... Das mit dem Terminalbefehl steht genau darüber in der Tabelle.

Ja, richtig, so wie von mir bereits in der Begründung erwähnt, neben noch 6 anderen Verwendungs-Fällen, weswegen man sie leicht überlesen kann.

Und Programmnamen sind Programmnamen - egal, ob das Programm mit TUI oder GUI läuft.

OK, dann sehe Dir bitte einmal den Artikel mount an.

Was man machen könnte ist, die Tabelle darüber eine Zeile für unformatierten Text hinzuzufügen statt es in den Fließtext darunter zu schreiben.

Gruß, noisefloor

IMHO eher nicht.

kB Team-Icon

Supporter, Wikiteam
Avatar von kB

Anmeldungsdatum:
4. Oktober 2007

Beiträge: 10176

Wohnort: Münster

linux_joy schrieb:

[…] Diesen hätte ich gerne umgeändert bzw. ergänzt zu:

Auch wenn Programme oft den gleichen Namen wie ein Paket haben, werden sie im Fließtext unformatiert gelassen, sofern es sich um GUI-Programme handelt. Terminal-Befehle hingegen werden dort in Monotype gesetzt.

Das ist so falsch, bzw. es entspricht nicht dem Layout, auf das man sich für das Wiki geeinigt hat und in diesem Artikel (und weiteren) normativ festgelegt hat.

GUI-Programme und Kommandozeilenprogramme werden nicht durch Formatierung unterschieden. Die Dateinamen von Kommandozeilenprogrammen treten allerdings als Teil von Befehlen auf dieser auf und können/werden dann deshalb im Fließtext als Monotype formatiert; aber nur, wenn man gar nicht den Programmnamen, sondern das Auftreten des Wortes auf einer Kommandozeile meint.

Programmnamen sind kompliziert, weil sie mit unterschiedlichen semantischen Bedeutungen auftreten können:

  • Eigenname

  • Dateiname

  • Teil eines Befehls

Genau deshalb – zur sichtbaren Unterscheidung der vom Autor gemeinten Semantik – gibt es die unterschiedlichen Formatierungen, die aber genau wie normativ vorgegeben verwendet werden müssen. Das ist nicht immer leicht. Aber jedenfalls sind die Formatierungsvorgaben nicht als Freibrief zu verstehen.

Das Beispiel unter dem von Dir fälschlicherweise beanstandeten Satz erklärt es bereits zutreffend. Hier ein weiteres Beispiel:

  • Die Shell Bash ist als Datei bash im Ordner /usr/bin/ abgelegt und kann auf der Kommandozeile mit bash gestartet werden. Man kann auch in der GUI per „Anwendungen → Hilfsprogramme → Terminal“ ein Terminal starten; in diesem läuft automatisch die Shell Bash.

noisefloor Team-Icon

Anmeldungsdatum:
6. Juni 2006

Beiträge: 29567

Hallo,

OK, dann sehe Dir bitte einmal den Artikel mount an.

Falls du die Illusion hast, dass das Wiki fehlerfrei ist: ist es nicht, war es nie, wird es nie sein. Für so Formatierungssachen wirst du fast immer einen Stelle im Wiki finden, wo es per Stand heute falsch ist, aber bis jetzt nie korrigiert wurden.

Aus Erfahrung kann ich dir sagen, das der besagte Fall auch ganz früher, also so 2004-2010 etwas anders gehandhabt wurde. Teilweise wurde da auch noch kursiv oder beim 1. Vorkommen fett oder so was in der Art verwendet. Erst später wurde das einheitlicher.

Meine _persönliche_ Meinung dazu ist: wenn du dich ins Wiki einbringen willst → teste Artikel oder schreibe neue. Es gibt einen Berg ungetesteter Artikel und einen Haufen Artikel, die nur für 20.04, was bald EOL ist, getestet sind. Jetzt kleinlich bei Formulierungen und Syntax zu werden bringt dem Wiki nichts, der Community nichts und dir nichts. Wenn der Artikel Wiki/Syntax der Fokus ist und der eigentliche Inhalt hin runter fällt, läuft grob was schief.

Gruß, noisefloor

linux_joy

Anmeldungsdatum:
6. Februar 2008

Beiträge: 803

Wohnort: Hannover

Hallo, kB und noisefloor,

vielen Dank für Eure prompten und ausführlichen Antworten.

kB schrieb:

linux_joy schrieb:

[…] Diesen hätte ich gerne umgeändert bzw. ergänzt zu:

Auch wenn Programme oft den gleichen Namen wie ein Paket haben, werden sie im Fließtext unformatiert gelassen, sofern es sich um GUI-Programme handelt. Terminal-Befehle hingegen werden dort in Monotype gesetzt.

Das ist so falsch, bzw. es entspricht nicht dem Layout, auf das man sich für das Wiki geeinigt hat und in diesem Artikel (und weiteren) normativ festgelegt hat.

(...) Aber jedenfalls sind die Formatierungsvorgaben nicht als Freibrief zu verstehen.

Das Beispiel unter dem von Dir fälschlicherweise beanstandeten Satz erklärt es bereits zutreffend. Hier ein weiteres Beispiel:

  • Die Shell Bash ist als Datei bash im Ordner /usr/bin/ abgelegt und kann auf der Kommandozeile mit bash gestartet werden. Man kann auch in der GUI per „Anwendungen → Hilfsprogramme → Terminal“ ein Terminal starten; in diesem läuft automatisch die Shell Bash.

Ja, jetzt meine ich, es verstanden haben zu können. Allerdings könnte die von Dir erläuterte Geschichte mit der Semantik sich auch ruhig z.B. in dem von mir kritisierten Satz wiederfinden, beispielsweise in Form von:

Auch wenn Programme (CLI wie auch GUI) oft den gleichen Namen wie ein Paket haben, werden sie im Fließtext unformatiert gelassen, sofern bei deren Erwähnung nicht explizit deren Paketname gemeint ist. Im letzteren Fall findet man aber unter InterWiki (Abschnitt „Distributionsspezifische-externe-Links“) zwei mögliche Lösungen. Allerdings ist Wiki/Referenz (Abschnitt „Paketinstallation“) unbedingt zu beachten! Außerdem können CLI- (bzw. Terminal-)Programme im Fließtext ausnahmsweise in Monotype formatiert werden, sofern dabei explizit deren Befehls-Charakter hervorgehoben werden soll.

Dies würde IMHO Klarheit schaffen. Evtl. könnte der vorstehende Sachverhalt ja noch durch ein Beispiel (zusätzlich zu dem bereits vorhandenen und vllt. auch zusätzlich zu dem von kB in 9451481 unten dargestellten; ergo als 3. Beispiel) veranschaulicht werden, etwa folgendermaßen:


Beispiel 3 (Lediglich der erste Satz ist Fließtext, der Rest kommt aus der [[Vorlage(PipxInstallation, Python-Modul)]]):

  • Weil in Ubuntu 24.04 die Pakete Foobar und Foobar leider beide fehlerhaft sind (→ 12345678 und 23456789), wird für dort die Installation via pipx empfohlen:

    pipx, als Wrapper-Programm des Python-Paketmanagers pip, stellt eine einfache Möglichkeit dar, in Python geschriebene Applikationen in isolierten Umgebungen zu installieren:

    pipx install Foobar       # Programm wird nur für den aktuellen Nutzer installiert  

Anmerkung: Das vorstehende Beispiel 3 wirft für mich allerdings die ergänzende Frage auf, ob und – falls ja – inwieweit es bei Paketnamen ein Wahlrecht bzgl. deren Formatierung gibt oder nicht. Denn immerhin:

Ergo: Es gibt ein Wahlrecht bzgl. der Formatierung von Paketnamen, allerdings nur bei APT- und snap-Paketen. Dies hat dann Folgen bzgl. der Erläuterung dieses Umstandes:

  • In Wiki/Syntax (Abschnitt „Textformatierung“) in der dortigen Tabelle „Textformatierung“ in der obersten Zeile („Fettschrift“) wird ergänzend auf diesen Umstand hingewiesen:

  • Unter der Tabelle „Textformatierung“ wird dann der bereits erwähnte Satz in eine Aufzählungsliste umgewandelt, und zwar so:

    • Bei Programmnamen ist im Fließtext Folgendes zu beachten:

      • Auch wenn Programme (CLI wie auch GUI) oft den gleichen Namen wie ein Paket haben, werden sie im Fließtext unformatiert gelassen, sofern bei deren Erwähnung nicht explizit deren Paketname gemeint ist. Für den letzteren Fall siehe aber bitte die Tabelle hier drüber, oberste Zeile („Fettschrift“), dort auch den Hinweis-Kasten.

      • Außerdem können CLI- (bzw. Terminal-)Programme im Fließtext ausnahmsweise in Monotype formatiert werden, sofern dabei explizit deren Befehls-Charakter hervorgehoben werden soll.

  • Das 3. Beispiel (zusätzlich zu dem bereits vorhandenen und vllt. auch zusätzlich zu dem von kB in 9451481 unten dargestellten) lautet folgendermaßen (das „Ungültige Makro“ ist [[Bild(Wiki/Vorlagen/PPA/ppa.png)]] und leider nur im Wiki verfügbar):

    • Beispiel 3 (Lediglich der erste Satz ist Fließtext, der Rest kommt aus der [[Vorlage(PipxInstallation, Python-Modul)]]; außerdem muss bei Verwendung der pipx-Paketvorlage nicht unbedingt auf die Fehlerhaftigkeit bzw. das Fehlen anderer Paketarten hingewiesen werden):

      • Weil in Ubuntu 24.04 die Pakete Foobar, Foobar und auch das PPA-Paket Foobar aus dem Archiv

        Ungültiges Makro

        Dieses Makro ist nicht verfügbar

        doof des Eigentümers/Teams dick leider alle drei fehlerhaft sind (→ 11234567, 12345678 und 23456789), wird für dort die Installation via pipx empfohlen:

        pipx, als Wrapper-Programm des Python-Paketmanagers pip, stellt eine einfache Möglichkeit dar, in Python geschriebene Applikationen in isolierten Umgebungen zu installieren:

        pipx install Foobar       # Programm wird nur für den aktuellen Nutzer installiert  

Was meint ihr dazu?




noisefloor schrieb:

(...) Wenn der Artikel Wiki/Syntax der Fokus ist und der eigentliche Inhalt hin runter fällt, läuft grob was schief.

Ich bringe mich doch auch sonst in das Wiki ein (siehe z.B. 9451370).

Antworten |