Hilfe Diskussion:Styleguide
Inhaltsverzeichnis
Platzhalterkonventionen
Wir müssen uns noch einigen über die Bezeichnungen des HSR-Benutzers und des lokalen Benutzers.
Siehe dazu vielleicht den Beitrag über die SMB-Shares.
Dort verwende ich die Konvention:
<user> = Lokaler Benutzer
<loginname> = HSR Benutzer
Ich würde die < und > weglassen und dafür die Platzhalter wie user, loginname etc fett und/oder kursiv drucken. Damit haben wir keine Probleme mit Usern, die vergessen die < und > auf ihrem Rechner weg zu lassen, ohne dass wir bei jeder Anleitung explizit darauf hinweisen. Ausserdem sollten meiner Meinung nach wo immer möglich (bspw. unter vpnc ) die als Argumente angegebenen Benutzernamen und vorallem Passwörter in " bzw. ' gesetzt werden. Gerade bei Passwörtern könnte es sonst sein dass einige User Leer- oder andere Zeichen verwenden, welche ungewollte Effekte hervorrufen würden.
Rettichschnidi 19:20, 14. Okt. 2008 (UTC)
Ich würde es bevorzugen "user" zu werwenden, wurde bisher auch in allen Artikel so gehandhabt.
Es wäre IMHO sinnvoll, die "" wegzulassen, eben weil es sonst garantiert Leute gibt, die sie stehen lassen. Ausserdem braucht es die " an gewissen Stellen wieder. Jedes mal zu erläutern, ob die " dieses Mal gebraucht werden oder nicht wäre IMHO zu umständlich.
Ich würde folgende Schreibweise vorschlagen:
Lokaler-Benutzername == Lokaler-Benutzer
Lokales-Benutzerpasswort == Passwort des lokalen Users
Lokales-Rootpasswort == Passwort von Root auf dem lokalen Rechner (dürfte die meisten Ubuntuuser eh nicht interessieren)
HSR-Benutzername == HSR Loginname
HSR-Passwort == HSR Passwort
Damit haben wir eine gewisse Flexibilität und müssen nicht immer wieder eine Erklärung abgeben.
--Rettichschnidi 22:51, 15. Okt. 2008 (BST)
Versionierung
Das MediaWiki bietet doch Versionierung an, weshalb sollen wir Änderungen noch explizit formulieren? Wenn dich eine Seite speziell interessiert, kannst man sie ja beobachten.
--Odi 12:09, 9. Okt. 2008 (UTC)
IMHO ist es überflüssig Änderungen manuell zu kennzeichnen. Mediawiki kann das viel besser.
Rettichschnidi 20:47, 9. Okt. 2008 (UTC)
Evtl. habe ich das ganze falsch verstanden, wenn man eine Änderung macht, bietet MediaWiki ja jeweils ein Feld "Zusammenfassung" an, dieses sollten wir wenn möglich befüllen um direkt den Sinn einer Änderung zu sehen.
Finde ich gut und sinnvoll.
--Odi 20:51, 9. Okt. 2008 (UTC)
Genau das meinte ich. Chrigu
Aufbau der Anleitungen
Wir sollten uns entweder auf einen einzige Distribution beschränken, oder aber die Installation jeweils getrennt von der allgemeinen Anleitung beschreiben. Es wäre wohl sehr unschön, wenn wir in jeder eine Anleitung je ein apt-get, yum, emerge sowie tar,configure, make Weg beschrieben hätten.
Rettichschnidi 21:28, 9. Okt. 2008 (UTC)
Ja du hast Recht, wäre nicht wirklich sinnvoll und Zielführend.
Vorschlag: Wir beschränken uns auf die jeweils aktuelleste Ubuntu-Version, dann haben wir ein System was sicher läuft. Die wenigen HSR Linux Dokumente sind ja auch für Ubuntu.
Ich habe im VPN Artikel den Gentoo-Hinweis entfernt, die Infos sind so oder so für alle relevant (zumal ich die Lösung auf ubuntuforums.org gefunden habe.
--Odi 21:38, 9. Okt. 2008 (UTC)
Irgendwo sollte auch stehen, dass die Anleitungen sich auf Ubuntu beziehen. --Felix 12:08, 14. Okt. 2008 (BST)
Ich denke dass Anleitungen, welche sich nicht nur auf Ubuntu beziehen, willkommen sein sollten, solange sie klar als solche gekennzeichnet werden. Man könnte z.B. ein Hinweis-Template analog der Warnmeldung für veraltete Artikel erstellen. --Danilo 20:51, 11. Okt. 2010 (BST)
Ich denke nach wie vor das Ubuntu am besten geeignet ist für Umsteiger von Mac oder Win. Die Anleitungen sollten sich deshalb immer auf Ubuntu beziehen, und wen jemand etwas anderes einsetzt wird er wohl Fortgeschritten sein, und selber aus den allgemeinen Hilfen zur Distribution und dem alt.comp.hsr-Wiki die richtige Lösung heraus finden. --chrigu
gui/bash
Ich würde Bash bevorzugen, da sie mit verschiedenen Distributionen eher das gleiche macht.
Wir schreiben Anleitungen vor allem für nicht allzu Linux-Kundige. Bin also der Meinung, dass wenn wir uns eh auf Ubuntu beschränken (im Moment jedenfalls) und gut damit leben können wenn es nur unter Gnome funktioniert.
Obwohl nicht extrem wichtig: Wie wollen wir eine Navigation durch ein Menues bschreiben? Mittels Menuenamen welche durch > (finde ich hässlich) oder -> verkettet werden? Oder ganz anders? --Rettichschnidi 01:36, 22. Okt. 2008 (BST)
Ich bin für Kursiv, mit > getrennt. --Danilo 20:52, 11. Okt. 2010 (BST)
Ich ziehe auch -> vor. Kursiv wäre gut denke ich --chrigu
Sprache für Screenshots
Ich bin dafür die Sprach-Guideline für Screenshots abzuschaffen. Ich habe z.B. mein System auf Deutsch eingestellt und will es für die Screenshots nicht extra auf Englisch umstellen, vor allem zumal die meisten User wohl sowieso deutschsprachige Systeme verwenden. Die HSR-Studenten sind sowieso nicht so blöd, dass sie Screenshots - welche als Zusatzhilfe dienen - nicht noch übersetzen könnten. So wies jetzt ist schrecken wir nur Leute ab, welche sonst ihre Screenshots beisteuern würden. --Danilo 20:56, 11. Okt. 2010 (BST)
Wer für Screenshots einen Ubuntu-Live-USB-Stick braucht kann den bei mir ausleihen. Ist für den Erfahrenen keine grosse Sache für den Leihen aber teilweise sehr verwirrend. (bei anderer Version oder anderem X-Manager teilweise sogar inkompatibel) --chrigu
Dateipfade
Wie wollen wir Dateipfade handhaben? Kursiv und inline? Monospace? Oder in einem Codeblock? Mein Vorschlag wäre ein <code>-Tag. --Danilo 21:16, 11. Okt. 2010 (BST)
Bei allen Wikiseiten die ich rasch auf die Schnelle angeschaut habe war es in normaler Schrift eindeutig. Was denken die Anderen? --chrigu
