Policies/Wiki Style
Aus Mandriva Community Wiki
Es besteht definitiv die Notwendigkeit der Kohärenz, wenn eine gewisse Anzahl von Leuten untereinander Dokumente redigieren - diese Policy umreißt daher die erforderlichen Mittel zum Editieren in diesem Wiki. Sie benennt ebenso die verschiedenen Templates und Styles, die du benutzen kannst und solltest und auch wann du sie gebrauchen solltest. Sie thematisiert desweiteren die Hierarchie und das Layout des Wiki, generelle Feinheiten der Bearbeitung sowie andere wichtige Informationen. Wenn du beim Pflegen und Bearbeiten von Dokumenten in diesem Wiki eine wertvolle Hilfe sein willst, und keine Belastung, ist das Lesen dieser Seite für dich ein Muss! Jeder hat seinen persönlichen Stil. Wir sehen das daran, wie eine E-Mail verfasst ist, wie SPEC-Dateien geschrieben sind und wie Einträge im vorigen Twiki geschrieben waren. Nur um nicht missverstanden zu werden, wir schätzen persönlichen Stil! Wenn nun aber ein ganzes Set von Dokumenten aufrecht erhalten werden soll, an denen jeder mitschreiben kann und das eine Menge Leute lesen, lässt ein gewisses Maß an Konsistenz das Wiki doch erheblich professioneller wirken, außerdem resultieren daraus weniger Unordnung, weniger kopierte Inhalte, weniger Frustration, und ein angenehmeres Arbeiten. Solltest du unfähig oder nicht gewillt sein, den in dieser Policy fixierten Punkten zu folgen, möchten wir dich bitten, das Editieren jeglicher Inhalte dieses Wiki zu unterlassen.
Seiten bearbeitenFasse getätigte Änderungen zusammenSchreibe stets eine kurze Zusammenfassung (en) in das gleichnamige Feld unter dem "Bearbeiten von ..."-Bereich. Beschreibe hierin nur knapp, welche Veränderungen du vorgenommen hast, so wie in der Zusammenfassung-Legende (en) beschrieben. Nutze die Vorschau-Funktion vor dem AbspeichernWenn du mit dem Editieren fertig bist, klicke auf "Vorschau zeigen" (en), um zu überprüfen, ob die vorgenommenen Änderungen die beabsichtigte Wirkung zeigen, bevor du sie permanent speicherst. Wiederhole den Editieren/Vorschau-Vorgang ggf. so oft, bis du mit dem Ergebnis zufrieden bist, und erst dann klicke auf "Seite speichern", womit deine Änderungen am Artikel tatsächlich wirksam werden. Signiere deine KommentareSigniere auf den "Diskussion"-Seiten der Wiki-Artikel deine Kommentare immer durch setzen von vier Tilde-Zeichen, am besten vom vorstehenden Text abgesetzt durch zwei Bindestriche (<Kommentar> -- Karl Wick 11:29, 8 December 2006 (MST)). Verfügbare Signaturen:
Schlankes LayoutInnerhalb des Wiki gibt es keine Namens- oder Verzeichnishierarchie (mehr), d.h.:
Falsch: Titel: Releases/Mandriva/2007/Errata
{{title|Mandriva 2007 Errata}}
Dies sind die Errata zu Mandriva 2007
Richtig: Titel: Mandriva_2007_Errata [[Category:Errata]][[Category:2007]] Dies sind die Errata zu Mandriva 2007 Hierbei sind '_' und ' ' im Titel equivalent. Titel-WahlBeim Wählen eines Titels für eine neue Seite bedenke bitte drei Dinge: Ein Titel muss
Als Hilfestellung, überlege dir einfach, was du bei einer Internetrecherche als Suchbegriff eingeben würdest, um zur fraglichen Wiki-Seite zu gelangen. 'Good Practices'Für die Such-Engine
Für gute Lesbarkeit
Für gute Zusammenarbeit
Style und TemplatesStil sowie die Art und Weise, wie Dokumente geschrieben werden, sind äußerst wichtig. Manche verwenden etwa die Wiki-Sytax, einige andere bevorzugen dagegen die HTML-Syntax. Einige kreieren Seitennamen wie "System Administration", während andere sog. "CamelCase" oder Kurznamen verwenden, wie "SysAdmin" oder "SystemAdministration". Manche werden bevorzugt "Paragraph"-Tags (<p>) nutzen, auch wenn es gar nicht nötig ist, andere statt dessen "Line break"-Tags (<br>). Manche Leute neigen zu excessivem "bolding" (Fett-Text) und "italics" (Kursiv-Text). All diese Dinge erfordern zumindest soweit normiert zu werden, dass Layout und Aussehen der Inhalte von Seite zu Seite konsistent bleiben. TemplatesMediaWiki erlaubt die Nutzung von Templates, welche es ermöglichen Text konsistent zu stylen, den wir markieren oder hervorheben wollen. Templates werden wie folgt angewendet: {{template|Text}} Um beispielsweise das title-Template zu nutzen, um der Beschreibung oder dem Namen einer Seite mehr Ausdruck zu verleihen, verwende: {{title|Dies ist der Titel des Artikels}} Eine Liste der derzeit verfügbaren Templates ist hier abrufbar. Von diesen müssen folgende Templates verwendet werden:
Alle diese Templates existieren, damit sie benutzt werden und sollten also auch konsistent in der beschriebenen Weise eingesetzt werden. Sie dienen dazu, hier diskutierte Dinge in ihrer Wirkung visuell zu unterstützen und Informationen wie Dateinamen oder Paketnamen hervorzuheben und zu markieren, um sie einfacher unterscheidbar zu machen. Hinweis: Sofern ein Template ein "="-Zeichen oder "Pipe"-Symbol (|) erfordert, wird es nicht funktionieren, ohne dass '=' oder '|' durch setzen der Tags <nowiki> und </nowiki> neutralisiert werden. StyleHier einige Einzelheiten bezüglich des Style von Seiten, die beim Bearbeiten beachtet werden sollten:
Interwiki-LinksDu kannst Interwiki-Links verwenden, um zu anderen Sprachen im Wiki und externen Webseiten zu verlinken, wie etwa Bugzilla. Zum Beispiel wird [[:bugz:12345]] automatisch nach http://qa.mandriva.com/show_bug.cgi?id=12345 verlinken. Wenn du magst, kannst du ihn noch etwas aufhübschen, indem du dies benutzt [[:bugz:12345|Bug #12345]], andernfalls wird der Link so aussehen: bugz:12345. So wendest du den "bugz"-Interwiki-Namen an, um die Bugzilla-URL darzustellen. Anstelle dessen kannst du dich aber auch für das chice {{bug|12345}}-Template entscheiden, wie auch immer, wenn du deinen eigenen Text verwenden, aber den Link beibehalten willst, ist es besser den Interwiki-Link als das Bug-Template zu benutzen, der es dir erlaubt, deinen eigenen Link-Namen einzusetzen (z.B. [[:bugz:12345|Das war ein fieser Bug]]). Wo immer Interwiki-Links verfügbar sind, benutze sie! Auf diese Weise, sollte sich eine URL irgendwann einmal ändern (z.B. Bugzilla ist nicht mehr unter http://qa.mandriva.com verfügbar), ist es eine Sache ein Record im Interwiki-Database table und ein Template anzupassen, eine ganz andere hingegen, hunderte einzelne individuelle Links abzuändern. Auch das olang-Template nutzt das selbe Interwiki-Linking. Um von einer Seite zur französischen Version der Seite zu verlinken, würdest du das olang-Template mit dem Interwiki-Link darin so anwenden: {{olang|[[:fr:Accueil|Franösisch]]}} Hier spezifiziert der "fr"-Interwiki-Name die französische Version der Seite, in diesem Fall "Accueil" bezeichnet. Damit würdest du nach /fr/Accueil geleitet; siehe Accueil. Aktuell unterstützte Sprachen sind:
Einfacher ist es allerdings bloß den l10n-Interwiki-Link derart zu benutzen: [[fr:Accueil|Französisch]] Wodurch Mediawiki ihn an einer speziellen Stelle positioniert. SyntaxHier einige Links zur Wiki-Syntax und was du wie mit Mediawiki anstellen kannst:
Eine neue Seite beginnenBevor du eine neue Seite zu einem Thema erstellst, solltest du sicher sei, zuvor gründlich nach einer entsprechenden gesucht zu haben. Möglicherweise existiert eine solche bereits und sollte dementsprechend bearbeitet werden, statt noch eine zweite zu erstellen. Falls du eine neue Seite erstellen musst, vergewissere dich, welcher Platz ihr gemäß den o.g. Regeln im Wiki zukommt. Wenn du eine Seite falsch oder eine Top level-Seite erstellst, wird sie irgendjemand löschen oder verschieben müssen, was zwar nicht schadet, dich aber frustriert und für jemand anderen extra Arbeit verursacht. Andere gute Hinweise, die anzumerken wären, findest du in Wikimedia's Neue Seite anlegen-Thema. Entfernen und umbenennen von SeitenBitte entferne oder benennen keine Seiten eigenmächtig um. Solltest du den Eindruck haben, eine Seite sei an einem Punkt, an den sie nicht gehört, wende dich mit deinem Anliegen bitte an die web-discuss-Mailingliste und einer der Administratoren wird die Verschiebung und/oder Löschung der Seite vornehmen, sofern es erforderlich sein sollte. Für Administratoren enthält Wikimedia einige nützliche Informationen:
Diskussion-SeitenDiskussion-Seiten sind eine excellente Ressource. Bei Twiki wurden Kommentare von Benutzern innerhalb des Dokumentes selbst platziert (ähnlich einem Changelog, wer was getan hat usw.). Bei Mediawiki ist dies nicht nur unnötig, sondern auch nicht gewollt. Benutzerkommentare auf einer Seite beeinträchtigen deren eigentliche Inhalte, lassen sie ungepflegt und eher dürftig aussehen. Stattdessen sollten die Diskussion-Seiten genutzt werden. Diese Seiten enthalten einen Changelog, wer wann was verändert hat und sie können ebenso Benutzerkommentare zum jeweiligen Thema beinhalten, Anfragen nach zusätzlichen Informationen und so fort. Diskussion-Seiten sind quasi das "Reißbrett" hinter dem tatsächlichen Inhalt. Anders als noch bei Twiki, gibt es keine Notwendigkeit ein "Changelog" vorzuhalten. Wenn du eine Seite editierst, du etwas in das "Zusammenfassung"-Feld schreibst (z.B. was getan oder geändert wurde), wird jeder, der den Verlauf der Seite einsieht, nicht nur deinen Namen sehen, sondern auch was du in das "Zusammenfassung"-Feld eingetragen hast (dein Changelog-"Eintrag") und wann du die Veränderung vorgenommen hast. Hinweis: Berücksichtige bitte auch das Wiki Style-Beispiel, welches alle hier diskutierten Markups illustriert. ExtensionsWir diskutieren (per web-discuss) die Integration verschiedener Mediawiki-Extensions, die hilfreich sein könnten ...
|
