Einleitung

Eine einheitliche Struktur des Wikis erleichtert Lesern den Einstieg und gibt ihnen das Gefühl, sich in einer vertrauten Umgebung zu bewegen. Weiterhin wird dadurch auch die Wartbarkeit allgemein erhöht.
Da die Wikiseiten von beliebigen Nutzern editiert werden können, kann die einheitliche Struktur und Konsistenz der Seiten leicht verlorengehen.
Um dies zu verhindern, sollten alle Nutzer beim Editieren einer im Folgenden festgelegten Vorgehensweise folgen.

Inhalt

Der Abschnitt Vorgehensweise beschreibt, wann man beispielsweise einen neuen Abschnitt in einer Seite erstellen, und welche Formatierung man verwenden sollte, während unter Bearbeitungstechnik beschrieben wird wie man dies umsetzt.

Vorgehensweise

Erstellung einer Seite

  • Bevor man eine Seite erstellt, sollte man mit der Suchfunktion überprüfen, ob schon Inhalte zu dem Thema existieren. Sofern ähnliche Inhalte vorhanden sind, kann man diese, wenn es Sinn macht, ergänzen. Ansonsten legt man eine neue Seite für die Inhalte an.
  • Viele Inhalte sind in Namespaces untergebracht. Also muss man darauf achten, die Seite im richtigen Namespace anzulegen. Falls für die Seite viele Unterseiten oder verlinkte Dateien zu erwarten sind, macht es Sinn für diese Seite einen Unternamespace, also einen Namespace im Namespace anzulegen.
  • Für die Seite sollte ein passender Name beziehungsweise Titel gewählt werden, der den Inhalt beschreibt. Dieser sollte aber nicht unnötig lang sein.
  • Zunächst editiert man nun die Seite, von der aus auf die neue Seite verwiesen werden soll. Hier fügt man den Link ein [[Neuer Seitenname]] (natürlich mit dem richtigen neuen Seitennamen) und speichert die Seite. Dadurch können andere Benutzer sehen, daß entsprechende Inhalte in Vorbereitung sind. Nun kann man den Link anklicken, und die neue Seite erstellen. Dieses Vorgehen hat weiterhin den Vorteil, daß man, unabhängig von verwendeten Sonder- und Leerzeichen, gleich einen funktionierenden Link auf die Seite hat.

Hinzufügen neuer Inhalte auf einer bestehenden Seite

  • Wenn es für eine bestehende Seite beziehungsweise ein Thema zusätzliche Informationen gibt, können diese hinzugefügt werden, um die Seite weiter zu verbessern.
  • Handelt es sich bei den neuen Inhalten nur um einige Ergänzungen oder “Infokrümel”, so sollten diese, sofern möglich, in den bestehenden Text eingebettet werden.
  • Wenn die neuen Inhalte einen neuen Aspekt oder ein Unterthema behandeln, welches bisher auf der Seite nicht angesprochen wird, so macht es Sinn, dafür einen eigenen Abschnitt mit Überschrift anzulegen.
  • Alle hinzugefügten Informationen sollten konsistent in die Seite eingefügt werden. Für einen Leser sollte sich die Seite also nicht als eine Art Forenthread darstellen, dem nach und nach Informationen hinzugefügt wurden, sondern als einheitliche Seite, mit durchgängiger Struktur, die in Thema sinnvoll gegliedert behandelt.

Sätze und Seiten restrukturieren

Manchmal haben bestehende Seiten zwar einen guten Inhalt, präsentieren diesen aber nur recht unstrukturiert. Sätze können aufgrund einer schlechten Struktur auch unverständlich wirken. Daher sollten Seiten wenn möglich umstrukturiert werden, damit diese besser zu lesen sind. Hierbei sollte natürlich der Inhalt, beziehungsweise die Aussage der Seite selber nicht verändert werden. Auf Seitenebene können Strukturelemente wie verschiedene Ebenen von Überschriften und Aufzählungen eingebaut werden. Auf Satzebene Hervorhebungen (kursiver/fetter Text) oder Umstellungen.

Editieren oder korrigieren bestehender Inhalte

  • Es gibt verschiedene Gründe, aus denen Inhalte verändert werden sollten.
  • Rechtschreib- und Formatierungsfehler können einfach korrigiert werden.
  • Wenn Teile des Inhaltes veraltet sind, kann man die aktualisierten Informationen einfügen, und die veraltete Information zunächst durchgestrichen markieren. Werden längere Blöcke ersetzt werden, sollte man diese gesondert markiert aufbewahren. Dadurch ist es dem Leser möglich nachzuvollziehen, was sich verändert hat.
  • Wenn man sich absolut sicher ist, daß eine aufgeführte Information inkorrekt ist, oder sie weiterer Erläuterung bedarf, kann man den entsprechenden Abschnitt einfach abändern.
  • Wenn man an einer bestimmten Information zweifelt, oder es Verständnisprobleme gibt. So sollte man ein FIXME daruntersetzen, und einen erläuternden Kommentar hinterlassen.

Löschen von Inhalten

  • Die in diesem Wiki vorhandenen Inhalte wurden nicht ohne Grund erstellt. Somit dürfen sie auch nicht ohne guten Grund gelöscht werden.
  • Wenn man der Meinung ist, daß ein bestimmter Inhalt gelöscht werden sollte, setzt man ein DELETEME und eine Begründung darunter.
  • Man gibt anderen also die Möglichkeit, sich den zu löschenden Inhalt anzusehen, und eventuell für eine Alternative zur Löschung zu argumentieren.

FIXMEs bearbeiten

  • Wenn man etwas Zeit hat, sollte man mit der Suchfunktion nach FIXME suchen, um alle Seiten zu sehen, die noch bearbeitet werden müssen.
  • Möglicherweise wurde ein FIXME auf einer selbsterstellten Seite gesetzt. Dieses sollte mit Priorität bearbeitet werden.
  • Je nach Zeit und Kenntnissen ist es von Vorteil, auch andere FIXME s zu bearbeiten, oder einen Kommentar dazu abzugeben.

Account anlegen

  • Wenn man öfters Inhalte verändert oder hinzufügt macht es Sinn, sich einen Account anzulegen. Dies geht mit dem [Anmelden] Knopf rechts unten auf jeder Seite.
  • Ist man eingeloggt, wird der Accountname anstatt der IP im Changelog jeder Seite angezeigt. Somit ist für die anderen besser ersichtlich, wer welche Änderungen vorgenommen, beziehungsweise welche Inhalte erstellt hat.
  • Nur wenn man einen Account hat, kann man Dateien hochladen.
  • Der bei der Accounterstellung angegebene Name wird, genau wie die E-mail Adresse, nicht automatisch angezeigt, es sei denn man fügt diese Daten über den Signatur Knopf auf einer Seite ein.
  • Die angegebenen Daten sind von einem Administrator einsehbar. Das Passwort wird nur als Hash gespeichert.

Bilder

Allgemeines

  • Bilder sollten zur Ergänzung von beschreibenden Texten verwendet werden, wenn dies dem Leser hilft, die Aussage des Textes eindeutiger zu verstehen, oder eine bestimmte Funktionalität zu finden.
  • Bilder können die Verständlichkeit eines Textabschnittes stark erhöhen, jedoch erzielt man meisstens den gegenteiligen Effekt, wenn nach jeder Zeile ein Bild eingebunden, oder auf den Bildern nur belanglose Dinge dargestellt werden. Weiterhin ist der Speicherplatz im Wiki (leider) begrenzt.
  • Die Abmessungen des Bildes sollten passend gewählt werden. So kann man bei Screenshots meisstens große Ränder abschneiden, um ein kleines Bild zu erhalten, welches das Wesentliche zeigt. Weiterhin kann es, je nach Inhalt des Bildes, auch Sinn machen dieses durch Skalierung zu verkleinern.
  • Bilder liegen normalerweise zusammen mit vielen anderen Bildern im gleichen Namespace. Sie sollten daher einen eindeutigen Namen bekommen. Beispielsweise “Erdbeeren_Großaufnahme_1.jpg” für die erste Großaufnahme einer Erdbeere auf der entsprechenden Seite.
  • Ein Bild wird über die Auswahlseite automatisch mit seinem Namespace eingefügt, beispielsweise so: {{wiki:lualogo.png}}. Da die Seite aber im gleichen Namespace wie das Bild liegt, sollte (in diesem Fall) “wiki:” entfernt werden. Damit ist diese Verlinkung dann unabhängig vom Namespace in dem die Seite und das Bild liegen.

Screenshots aus dem Spiel

  • Diese Screenshots enthalten meisstens eine hohe Anzahl verschiedener Farben und Farbübergänge.
  • Normalerweise braucht hier nicht jedes Detail pixelgenau wiedergegeben werden, man wählt also ein verlustbehaftetes Kompressionsformat: JPEG.
  • Es ist möglich, die Kompressionsstärke einzustellen. Eine hohe Kompression bedeutet aber meisstens ein schlecht aussehendes Bild.
  • Es sollte ein Kompromiß zwischen Dateigröße und Bildqualität gefunden werden. Mit dem Programm JPEG Wizard v1.4 kann man die Kompression in Echtzeit verändern, und die Auswirkungen auf Dateigröße und Bildqualität sehen.

Screenshots aus Programmen

  • Diese Screenshots enthalten meisst eine geringe Anzahl verschiedener Farben und viele gleichfarbige Flächen.
  • Hier sollten Details, wie beispielsweise Text, Knöpfe und Fensterbegrenzungen orignalgetreu wiedergegeben werden, um die Lesbarkeit nicht zu verringern. Man wählt also ein verlustfreies Bildformat: PNG oder notfalls auch das schlechtere GIF.
  • Normalerweise verweist man auf eine bestimmte Stelle im Screenshot. Diese wird normalerweise rot unterstrichen, oder mit einem Pfeil markiert, damit diese leichter zu erkennen ist.
  • Zur einfachen Erstellung größenoptimierter PNG Bilder gibt es eine entsprechende Anleitung

Dateianhänge

  • Manchmal ist es nötig, herunterladbare Dateien auf einer Wikiseite zu verlinken. Hierbei handelt es sich meisstens um selbsterstellte Beispielkarten.
  • Damit nicht auf externe, möglicherweise später nichtmehr vorhandene, Server für die Datei verwiesen wird, wird diese ins Wiki hochgeladen.
  • Eine Datei wird über die Auswahlseite automatisch mit ihrem Namespace eingefügt, beispielsweise so: {{wiki:anhang.7z}}. Da die Seite aber im gleichen Namespace wie der Dateianhang liegt, sollte (in diesem Fall) “wiki:” entfernt werden. Damit ist diese Verlinkung dann unabhängig vom Namespace in dem die Seite und der Anhang liegen.
  • Dateien werden vorher grundsätzlich komprimiert um Platz zu sparen.
  • Es sollten nicht unnötig viele/große Dateien hochgeladen werden, da der Platz im Wiki nicht unendlich ist.
  • Das verbreitete Zip Format hat eine zu geringe Kompressionsrate, es verschwendet (im Verleich zu neueren Verfahren) Platz.
  • Bevorzugtes Archivformat 7-Zip.
    • Derzeit beste Kompressionsrate.
    • Einstellungen im Programm um selbige zu erreichen:
      • Archivformat: 7z
      • Kompressionsstärke: Ultra
      • Kompressionsverfahren: LZMA
      • Wörterbuchgröße: 64MB (ist für kleine Dateien Overkill, aber generell eine gute Einstellung)
      • Wortgröße: 255
      • Kompaktes (solid) Archiv erstellen
    • Freies, offenes Kompressionsformat.
    • Die verlinkte Anwendung zur (De)Kompression ist ein kostenloses Open-Source Programm.
    • Das Format ist noch nicht sehr weit verbreitet.
  • Alternatives Archivformat RAR.
    • Sehr hohe Kompressionsrate
    • Einstellungen im Programm um selbige zu erreichen:
      • Archivformat: RAR
      • Kompressionsmethode: sehr gut
      • Progressives (solid) Archiv
    • Proprietäres, geschlossenes Kompressionsformat
    • Bei der verlinkten Anwendung handelt es sich um Shareware. Eine kostenpflichtige Registrierung ist also bei längerer Benutzung Pflicht.
    • Das Format hat eine mittlere bis gute Verbreitung.

Bearbeitungstechnik

Sperrzeit

  • Wenn eine Seite oder ein Seitenabschnitt editiert wird, ist diese(r) automatisch für die Bearbeitung durch andere Benutzer gesperrt. Somit können keine Inhaltskonflikte auftreten, da nur ein Nutzer einen bestimmten Inhalt zur Zeit verändern kann.
  • Sobald die Änderungen mit dem [Speichern] Knopf gesichert, oder dem [Abbrechen] Knopf verworfen wurden, ist die Seite entsperrt, und kann wieder von anderen Benutzern bearbeitet werden.
  • Die bearbeitete Seite wird automatisch nach 15 Minuten entsperrt. Somit könnten hier möglicherweise zwei Benutzer den gleichen Inhalt bearbeiten, wodurch die Änderungen eines Benutzers verlorengehen würden. Dem kann man aber vorbeugen. Immer wenn man den [Vorschau] Knopf drückt, wird das Zeitlimit zurückgesetzt, und die Seite ist wieder volle 15 Minuten gesperrt.
  • Besonders wenn man einer Seite viele Inhalte hinzufügt, also sie über längere Zeit editiert, sollte man gelegentlich die Änderungen mit dem [Speichern] Knopf sichern, damit diese nicht durch einen unbedachten Mausklick oder einen Absturz des Browsers verlorengehen können.

Syntax und Formatierung

FIXME Dieser Abschnitt muss noch “in Form” gebracht werden. Um selber Seiten zu bearbeiten, kann man die entsprechenden Knöpfe im Editorfenster verwenden.
Einige Dinge kann man aber nur direkt im Fenster schreiben,
daher sollte man sich vorher die Syntaxseite ansehen.
Dort müssen allerdings noch ein paar praktische Beispiele eingefügt werden.

 
wiki/howto.txt · Zuletzt geändert: 2009/08/29 10:42
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki