Archiv/Wiki/Schnelleinstieg

Archivierte Anleitung

Dieser Artikel wurde archiviert. Das bedeutet, dass er nicht mehr auf Richtigkeit überprüft oder anderweitig gepflegt wird. Der Inhalt wurde für keine aktuell unterstützte Ubuntu-Version getestet. Wenn du Gründe für eine Wiederherstellung siehst, melde dich bitte in der Diskussion zum Artikel. Bis dahin bleibt die Seite für weitere Änderungen gesperrt.


Anmerkung: siehe http://forum.ubuntuusers.de/post/2840575/

Zum Verständnis dieses Artikels sind folgende Seiten hilfreich:

  1. Inhaltliche Referenz

  2. Die Wiki-Syntax

  3. Kopiervorlage für Wiki-Seiten

  4. Textbausteine

  5. Symbole

Inhaltsverzeichnis
  1. Referenz?
    1. Ja, aber...
  2. Strukturvorgaben
    1. Vor dem eigentlichen Text
    2. Im Text

Im Artikel Wiki/Benutzung wird die Bearbeitungs- und alle weiteren Funktionen des Wikis erklärt.

Referenz?

Viele User möchten einen Artikel im Wiki schreiben. Doch häufig weiß man nicht genau, wie so ein Artikel aussehen soll. Es geht hier darum, einen Artikel bereit zu stellen, der selbsterklärend als eine Referenz für einen eigenen Artikel dienen kann. In erster Linie soll hier verdeutlicht werden, worauf bei der formalen Struktur zu achten ist. Dieser Absatz ist also eine einleitende Erklärung worum es in diesem Artikel geht. Eine solche sollte jedem Artikel vorausgehen. [1]

Ja, aber...

Wie geht denn das? Wo finde ich das? Ich weiß nicht wie das geht! Sicher wird der eine oder die andere vor diesen Fragen stehen. Auch dieser Artikel stellt keine umfassende Anleitung dar. Es wird auf fünf weitere Seiten innerhalb dieses Wikis verwiesen, auf denen alle Informationen zur Erstellung von Artikeln zu finden sind und darüber hinaus werden Begründungen geliefert, warum das einen Sinn hat. Ohne ein aufmerksames Lesen dieser Seiten aus dem Wissens-Block ist auch das Verständnis dieser Seite leider nicht gänzlich möglich. Ein guter Artikel sollte auch einschränken und darauf hinweisen, was hier nicht zu finden ist.

Strukturvorgaben

Es gibt einige wichtige Funktionen, die ein Wiki bereitstellt, um den Text einheitlich und ansprechend zu formatieren. Ein guter Artikel hält sich an folgende Vorgaben:

Vor dem eigentlichen Text

Gültigkeitsmarkierungen

Dies sind die Blöcke, die auch diesem Artikel vorn angestellt sind und farblich stark hervorgehoben sind. Sie informieren den Leser, welchen Status die folgenden Informationen haben. "Getestet mit..."; "Dieser Anleitung fehlen noch Informationen", "Warnung"; etc. Sie sind alle in der Vorlage enthalten und müssen zum Gebrauch lediglich auskommentiert werden [3]. Sie sind auch in den Textbausteinen zu finden [4]. Die nötigsten Hinweise in aller Kürze findet man aber auch als Hinweis in jeden leeren (=neu angelegtem) Artikel.

Vorausgesetzte Kenntnisse

Für die Schilderung eines Sachverhaltes, einer Problemlösung oder anderen Themen muss meist auf weiteres Wissen zurückgegriffen werden. Aber es ist nicht sinnvoll, eine Anleitung, die es an einer anderen Stelle im Wiki bereits gibt, zu wiederholen, zumal dann das selbe Wissen an zwei Stellen gepflegt werden müsste.

Auf Vorwissen, das in dem Artikel benötigt wird, wird im Wissens-Block verwiesen. So müssen nur noch die Verweise aufgezeigt werden, indem man den entsprechenden Punkt dieser Liste in eckigen Klammern in den Text einfügt, beispielsweise [2]. So bleibt der Artikel auf die wesentlichen Informationen beschränkt und behält seine Übersichtlichkeit. So sind auch in diesem Text eine Vielzahl von Verweisen auf andere Seiten zu finden.

Inhaltsverzeichnis

Ein längerer Artikel stellt auf jeden Fall ein Inhaltsverzeichnis bereit. Dies muss nicht manuell erstellt werden, sondern kann über eine Funktion im Wiki automatisch generiert werden [2]. In der Vorlage ist diese Funktion bereits enthalten [3].

Im Text

Im eigentlichen Text gibt es neben den inhaltlichen Kriterien [1] Einiges zu beachten, was einen einheitlichen und leicht zugänglichen Text verständlich macht. So werden folgende Formatierungen genutzt:

Syntax Ergebnis Verwendung
'''Fettschrift''' Fettschrift Dateien, Ordner, Pakete, Dateiendungen/Formatnamen (.txt, PDF),. Dateisysteme (ext3)
''Kursiv'' Kursiv Menüelemente wie "Orte -> Computer", Button "OK", Reiter "Extras". G-Conf-Schlüssel wie "apps/compiz/plugins/fade/screen0/options/window_types"; zur Abgrenzung dabei immer Anführungsstriche setzen"
`Monotype || Monotype || Für Werte, Befehlsoptionen und -parameter außerhalb des Befehlsparsers, wie --verbose.; außerdem für Textelemente aus Code-Angaben, Befehle, Gruppennamen, Module im Fließtext|| Wenn es also um die '''Datei.bsp''' oder das '''Paket.deb''' in meinem Ordner '''/home/username''' geht, wird dies Fett hervorgehoben. === Textboxen === Will man einen Befehl für die Konsole kenntlich machen oder einen Text darstellen, den man in eine Datei kopieren soll, werden die dazugehörigen Parser verwendet, welche sich auch in der Vorlage befinden [2] [3]. {{{#!vorlage Befehl So werden die Konsolen-Befehle dargestellt. }}} Damit jeder leicht erkennen und unterscheiden kann, worum es geht. {{{ Und dies ist ein Text, den der Leser in eine Datei kopieren kann. }}} Dies ist einfach übersichtlicher. Und wenn man dies mit der Maus markiert, hat man es leichter, weil sich der Text von der Umgebung abgrenzt. {{{#!vorlage Warnung Gibt es eine Stelle in der Anleitung, die besonders wichtig ist und die einen Fehler zur Folge haben könnte, durch den man wichtige Einstellungen oder Daten zerstört? }}} Man sollte so freundlich sein und den Leser davor warnen [2] [4]. === Icons und Bilder === [[Bild(Wiki/Icons/tux.png, 32, left)]] [[Bild(Wiki/Icons/tux.png, 32, right)]]Symbole typischer Anwendungen machen den Text auch visuell greifbar. So kann der Leser z.B. in seinen Menüs die Anwendungen leicht finden, weil die Symbole leicht wieder erkannt werden können [5]. Manchmal machen auch ganze Bilder viele Dinge verständlicher und sollten einem guten Artikel hinzugefügt werden [2]. Dabei muss man aber auf die Größe achten (siehe auch [:Wiki/Screenshots:])! [[Bild(./beispiel.png, align=center)]] = Kategorien hinzufügen = Um die Übersicht und Verlinkung im Wiki zu gewährleisten, werden nun noch eine oder mehrere passende Kategorien aus der Vorlage ("tag") aktiviert, indem man eine der Rauten (#) entfernt [3]. Alle nicht verwendeten Kategorien müssen '''zwingend''' entfernt werden! = Zum Schluss = Wie ein gutes Buch oder ein guter Film, sollte ein Artikel damit enden, dass auf weitere Informationen verwiesen wird oder Ausblick auf zusammenhängende Themen gegeben wird. == Tipps & Tricks == * Wer jetzt noch keinen genauen Überblick hat, sollte nicht verzweifeln. Am besten öffnet man sich auf der Baustelle eine neue Seite unter Verwendung der Vorlage und probiert ein wenig herum. '''Wenn es nicht sofort toll aussieht, ist das nicht schlimm! Niemand wird sich darüber beschweren.''' Es ist ja eine Baustelle! * Wenn man wissen möchte, was man genau in das Textfeld schreiben muss, damit es so aussieht wie auf einer bestimmten Seite, man sich aber nicht traut diese Seite zum Editieren zu öffnen, dann gibt es eine einfache Funktion: "''Weitere Aktionen -> Rohformat''". Hier kann man den Text sehen, wie er in den Editor eingegeben wurde. Man kann sich nun gefahrlos etwas heraus kopieren. == Links == Sind es nur wenige Links, muss man diese nicht extra unterteilen. === Intern === * [:Wiki/Referenz:Inhaltliche Referenz] * [:Wiki/Syntax:Die Wiki-Syntax] im Detail * [:Wiki/Kopiervorlage:Kopiervorlagen] * [:Wiki/Hilfsmittel:Hilfsmittel] für Wiki-Autoren * [:Wiki/Textbausteine:Textbausteine] * [:Wiki/Begriffe:Begriffe] - Mounten oder Einbinden? Hier findet man die Antworten. * [:Wiki/Icons:Symbole] - Einige Symbole, die man für Seiten verwenden kann. * [:Wiki:Alles über dieses Wiki] - Eine Gesamtübersicht === Extern === * [http://www.ubuntu.com Gibt es interessante Links, ...] {en} * [http://www.ubuntuusers.de ...die außerhalb dieses Wikis liegen?] {de} Die Fähnchen bei externen Links nicht vergessen [2]! Dann weiß man, auf welche Sprachen man sich einstellen muss. # tag: Wiki