Bearbeiten · Veränderungen zeigen · Druckansicht ·

Selbst einen Artikel beisteuern

Schön, dass du dich entschlossen hast hier einmal reinzuschauen. Du willst also aktiv am irc-guide.de Wiki beteiligt sein, ja? Das ist super, wenn du noch nicht weißt, was ein Wiki ist, dann lies dir bitte den Artikel Wiki durch.

Ich bitte dich dir diesen Artikel einmal genauestens durchzulesen. Hier findest du Informationen und Hinweise wie ein Wiki-Artikel auszusehen hat, was inhaltlich und layouttechnisch beachtet werden muss. Aber lass dich nicht abschrecken, es ist nichts weltbewegendes. Außerdem findest du hier Hilfen, wie man den WikiSyntax benutzt um bestimmte Schriftformatierungen zu erhalten. Also los!

Aufbau und Inhalt eines Wikiartikel

Du surfst auf irc-guide.de herum. Dir fallen Links auf, die ein ? am Ende haben. Du würdest gerne sehen was sich hinter diesen Links verbirgt, doch da ist ... nichts. Du ahnst es schon, Artikel, die mit einem hochgestellten Fragezeichen hinterlegt sind existieren noch nicht. Dies ist deine Chance diese Seiten ins Wiki-System einzutragen. Dabei bitte ich dich folgende grundlegende - und fast schon selbstverständliche - Regeln zu beachten.

Anrede, Kontakt zum Publikum

Das Publikum von irc-guide.de ist jung. Schätzungen nach zu urteilen sind über 90% der Besucher unter 30 Jahre alt. Daraufhin habe ich (Hendrik) beschlossen, dass der Benutzer auf irc-guide durchweg mit einem freundlichen Du angesprochen wird. Ich bitte dich dies in deinen Tutorialen und Beiträgen zu berücksichtigen. Hier sollen Fertigkeiten und Wissen auf eine möglichst sympathisch-junge Art und Weise vermittelt und ausgetauscht werden. In einigen Anleitungen taucht außerdem noch das kollegiale "Wir" auf, mit dem wir gemeinsam versuchen, dir bei schwierigen Sachen unter die Arme zu greifen. Dieses Wir vermittelt das Gefühl von Unterstützung seitens des Autors.

Nicht so gerne gesehen ist hier ein "ihr" ("Jetzt müsst ihr nur noch...") oder ein formales "Sie".

Namensgebung

Das mit der Namensgebung ist relativ einfach. Ein Artikel heißt nach dem, was in ihm vorkommt. Wenn ich generell über Bouncer schreiben will, dann schreib' ich das in Bouncer. Wenn es zu mehreren Artikeln (theoretisch) einen übergeordneten Artikel geben könnte, dann schreibe ich den Artikelnamen mit diesem übergeordneten Thema vorneweg. Klingt schwierig, ist aber einfach. Gemeint ist es so: Wir haben hier einen Artikel im System, der nennt sich psyBNC Installation und Konfiguration. Ihm vorneweg steht "psyBNC", denn das Thema psyBNC ist ihm wohl übergeordnet, stimmts? Auf der Seite psyBNC sollte dann erstens eine Erklärung zum Thema "psyBNC" stehen, und zweitens natürlich ein Link auf alle Seiten, die sich mit dem psyBNC beschäftigen, wie psyBNC Installation und Konfiguration eben. Der Sinn dahinter ist natürlich klar. Wir können den Artikel zur Installation und Konfiguration eines psyBNCs nicht einfach "Installation und Konfiguration" nennen, denn es gibt ja noch ein paar andere Programme auf dieser Webseite, die man mal eben installieren und konfigurieren könnte. IRC-Server? oder X-Chat zum Beispiel. ;-) Also, Namensgebungsregel: Schauen, ob sich das gewählte Artikelthema einem bestimmten anderen Artikel unterordnen lässt, dann bennen wir unseren Artikel so: "OberThema Thema meines Artikels". Und damits wirklich jeder versteht, ein paar Beispiele:

Bitte vermeide es Bindestriche (und Unterstriche) in Wikiartikelnamen zu benutzen. Oberthema und Thema des Artikels sollen nicht durch Bindestriche getrennt werden. Zusammenhängende Wortgruppen sollen ebenfalls nicht durch Bindestriche verbunden, sondern auseinander geschrieben oder gleich zusammengezogen, werden.

Richtig werden Bindestriche nur dort angewandt, wo sie elementarer Bestandteil eines Namens sind (Siehe Beispiele) oder wo ein Wortteil weggelassen wurde (zum Beispiel PsyBNCInstallations-UndKonfigurationsFAQ).

Beispiele zur Benutzung von Bindestrichen:

Ja, es gibt zum Zeitpunkt der Festlegung dieser Richtlinie einige Artikel, die sich nicht an diese Namenskonventionen halten. Sie werden hoffentlich peu à peu umbenannt.

Eindeutig muss er sein

Du schreibst immer jeweils zu einem bestimmten Thema. Dein Artikel ist eine "Abhandlung" über dieses Thema. Demzufolge musst du als Autor auch bei diesem Thema bleiben. Abschweifen ist blöd. Praktisches Beispiel: Stell dir vor, du schreibst einen Artikel über mIRC und fängst plötzlich an, in diesem Artikel auf mIRCs größten Konkurrenten, sagen wir mal X-Chat, zu sprechen zu kommen. Das eine gehört jawohl in den einen Artikel, das andere in den Anderen. Zwei Themenfelder zu mischen ist relativ ungünstig. Deshalb lautet die erste Regel bei uns hier im Wiki, dass die Themenausrichtung des Artikels schon am Namen der Wikiseite zu erkennen sein soll - nicht mehr, aber eben auch nicht weniger!

Inhaltlich korrekt muss er sein

Mit diesem Punkt haben eine Menge Leute Schwierigkeiten. Das Problem ist oft das technische Verständnis. Um es auf einen gewissen Grundtenor zu bringen: Das was du schreibst muss inhaltlich und technisch (zumindest auf einem grundlegenden Niveau) richtig sein. Du musst aufpassen, dass - vorallem bei den Tutorials und HowTos - deine Lösungen auf allen größeren benutzten Systemen laufen. Es nützt keinem SuSE-Anwender? etwas, wenn im Tutorial oidentd Installation und Konfiguration (was ja einen allgemeingültigen Anspruch erhebt) nur drin steht "Zum Installieren musst du nur 'apt-get install oidentd' eingeben!" Denn außer Debian benutzt keine Distribution das Programm apt-get! Ich denke die Problematik ist verständlich. Erwäge alle Möglichkeiten, schreibe zu jedem Etwas. Der größtmöglichen Menge an Besuchern soll geholfen werden, das ist unser Ziel.

Verständlich muss er sein

Ein brilliant erdachter, für alle Eventualitäten ausgerüsteter, vollkommen perfekt passender Artikel ist komplett wertlos, wenn es keinen Spaß macht ihn zu lesen. Den Spaß am Lesen verliert man ziemlich schnell, wenn der Autor sich nicht mal die Mühe gemacht hat seinen Artikel in korrektem Deutsch zu verfassen. Deshalb werden hier jetzt mal einige klare Richtlinien aufgestellt, die unbedingt beachtet werden müssen:

  • Formuliert grammatikalisch einwandfreie Sätze
  • Achtet unbedingt auf die korrekte Verwendung von Satzzeichen (Punkt, Komma, Fragezeichen, Ausrufezeichen, Gedankenstrich)
  • Achtet dringend auf die Groß- und Kleinschreibung
  • Strukturiert eure Artikel mit Überschriften, Listen (nummeriert oder unnummeriert), eventuell Tabellen oder horizontalen Linien (Wie das geht steht weiter unten).
  • Aber geht mit den Formatierungen sparsam um (Nicht übermäßig kursive, fette, fettkursive, farbige oder unterstrichene Formatierungen benutzen! Das nervt.)
  • Versuche deinen Schreibstil nicht zu langweilig zu gestalten ;-)

Ob man's glaubt oder nicht, werden diese Regeln beachtet, dann kommt schon ein wirklich brauchbarer Artikel dabei raus. Einen Gedanken sollten wir auch unseren ausländischen Besuchern widmen, sie versuchen recht häufig sich die deutschsprachigen Artikel mit diversen Übersetzungsmaschinen in ihre Muttersprache zu übersetzen. Das klappt natürlich nur dann, wenn der Autor wert auf gutes Deutsch gelegt hat, das der Übersetzer dann auch versteht.

Bereits bestehende Artikel verändern

TODO

WikiSyntax, Schriftformatierung, Befehle

Dieses Wiki, übrigens wie viele anderen Wikis auch, verwendet seine ganz eigene Sprache um Texte und die Seiten selbst zu formatieren. In diesem Forum kann kein HTML oder BBCode angewandt werden, die Sprache, die hier 'gesprochen' wird heißt WikiSyntax.

Ganz viel über den WikiSyntax, also die Beschreibungssprache in diesem System, kann man lernen, wenn man sich einmal die Seite Grundlagen der Bearbeitung? anschaut. Dort finden sich alle möglichen und unmöglichen Formatierungsoptionen.

Falls ihr mal nicht wisst, wie etwas zu realisieren ist, könnt ihr euch durch "Bearbeiten" oben rechts den Syntax abgucken und ihn in euren Artikel kopieren. Wenn ihr eure Wikisyntaxfähigkeiten ausprobieren wollt, dann könnt ihr das gern in der Wiki Sandbox machen, denn zum ausprobieren ist sie da!

Trotzdem will ich die allerwichtigsten Befehle hier nochmal zusammenfassen.

Überschriften

Überschriften erzeugt man, indem man ein oder mehrere Ausrufezeichen vor einen neuen Absatz stellt. Beispiel:

Überschrift erster Ordnung

Überschrift zweiter Ordnung

Überschrift dritter Ordnung


! Überschrift erster Ordnung
!! Überschrift zweiter Ordnung
!!! Überschrift dritter Ordnung

Ganz einfach, oder? Bitte benutzt Überschriften um die Wikiartikel zu gliedern.

Hinweis: Der Titel der Wikiseite bzw. des Artikels sollte am Anfang des Dokuments mit einem !Titel des Wikiartikels eingeleitet werden. Damit ist außerdem festgelegt, dass der Titel des Artikels immer die Überschrift ersten grades trägt. Alle weiteren Überschriften sind dieser Überschrift untergeordnet (tragen also mindestens !! ).

Im Text

Schriftformatierung generell

Ich zeig euch das am besten anhand von einigen Beispielen:

Hallo, ich bin ein Beispieltext.online jobs Einige Wörter in mir sind fett, andere sind nur kursiv, ganz dicke kommt es mit den fettkursiven Abschnitten.

Aber das ist nicht alles, man kann mich auch noch höher oder tiefer stellen. Oft verwendet, aber nicht gern gesehen sind unterstrichene Textstellen, denn normalerweise sind nur Links unterstrichen!

Ansonsten kann man mich noch einfärben!


Hallo, ich bin ein Beispieltext.

Einige Wörter in mir sind '''fett''', andere sind
nur ''kursiv'', ganz dicke kommt es mit den
'''''fettkursiven''''' Abschnitten.

Aber das ist nicht alles, man kann mich auch noch
'^höher^' oder '_tiefer_' stellen. Oft verwendet,
aber nicht gern gesehen sind {+unterstrichene Textstellen+},
denn normalerweise sind nur [[#links|Links]] unterstrichen!

Ansonsten kann man mich noch %red%ein%blue%fär%green%ben%%!

Zeilenumbrüche

Zeilenumbrüche und Absätze macht das Wiki automatisch für euch, sobald ihr eine Leerzeile zwischen zwei Absätzen stehen habt. Ein einfacher Zeilensprung ("nur einmal Enter") hat keine Auswirkungen auf das Layout

Einrückungen

Ich bin ein Normaler Absatz
->Man kann Absätze einrücken, indem man ihnen ein -> voranstellt
-->Das geht sogar über mehrere Ebenen
--->Hey, das lässt sich prima für wichtige Einschübe benutzen
-->Eben!
Und ich bin wieder normal.

Wird zu:

Ich bin ein Normaler Absatz

Man kann Absätze einrücken, indem man ihnen ein -> voranstellt
Hey, das lässt sich prima für wichtige Einschübe benutzen
Du sagst es
Eben!

Und ich bin wieder normal.

Listen

Unnummerierte Listen werden mit Sternchen gebaut. Je mehr Sternchen, desto tiefer die Verschachtelung:

  • Feuer
    • Hell
    • Heiß
      • Aua!!
  • Wasser
    • Kühl
    • Nass
* Feuer
** Hell
** Heiß
*** Aua!!
* Wasser
** Kühl
** Nass

Numerierte Listen funktionieren genau gleich, nur dass wir anstatt der Sternchen Rautezeichen (#) verwenden. (Die Raute wird übrigens in einigen Ländern als Synonym für 'Nummer' oder 'Zahl' verwendet)

  1. Feuer
    1. Hell
    2. Heiß
      1. Aua!!
  2. Wasser
    1. Kühl
    2. Nass
# Feuer
## Hell
## Heiß
### Aua!!
# Wasser
## Kühl
## Nass

Links

Das wichtigste sind wahrscheinlich die Links in einem Wikisystem. Den zu linkenden Artikel fügt man einfach in [[ und ]] ein. Ales was dazwischen kommt wird automatisch zum Link umgewandelt. Wenn ihr etwas wie [[Wiki Sandbox]] in eure Artikel schreibt, dann kommt Wiki Sandbox dabei raus. Da dieses Wiki die Leer- und Sonderzeichen so wie so aus den Wikilinks herauszieht ist [[Wiki Sandbox]] genau dasselbe wie [[WikiSandbox]], nur das Aussehen wird dadurch verändert. Das Ziel hinter diesem Link bleibt gleich: Wiki Sandbox und WikiSandbox.

Man kann den Links auch anders anzeigen lassen: [[Wiki Sandbox|Hier die Spielkiste zum Ausprobieren!]] wird zu einem Link, der zur Sandbox führt, aber wie folgt betitelt wird: Hier die Spielkiste zum Ausprobieren!

Externe Links sind fast noch viel einfacher. Sie funktionieren wie interne Links, nur dass man die vollständige URL (also mit http://) mit angeben muss! [[http://irc-guide.de]] wird zu http://irc-guide.de. [[http://irc-guide.de|Die beste Seite der Welt]] wird zu Die beste Seite der Welt.

"Anker" (also bestimmte Scrollpositionen) in einer Webseite baut man mit [[#namedesankers]]. So kann man zum Beispiel mit [[#listen|zu den Listen gehen]]. zu den Listen gehen ;-)

Besondere Boxen für Codes, Commandos und Screengrabs.

Es gibt in diesem Wiki hier drei besondere, farblich gekennzeichnete, Boxen für vorformatierten Text, wie er zum Beispiel häufig bei Codeeingaben oder Ähnlichem vorkommt.

Alles, was als Kommando irgendwo eingetippt werden muss, kommt in eine blaue %commandlisting%-Box das sieht in etwa so aus:

$> echo Hallo Welt
Hallo Welt

Der Code dazu:

%commandlisting% [@
$> echo Hallo Welt
Hallo Welt

@]


Alles, was als Inhalt einer Konfigurationsdatei, als Quellcode oder als sonstiger Code zu betrachten ist, kommt in eine rote %codelisting%-Box. Etwa so:

user root {
        default {
                force reply "UNKNOWN"
        }
}

Der Quellcode dazu:

%codelisting% [@
user root {
        default {
                force reply "UNKNOWN"
        }
}

@]


Alles, was man als "Screenshot" einer Console (auch "Screengrab" genannt) ansehen kann - also wenn du verdeutlichen willst, was grade auf dem Bildschirm des Lesers stehen sollte - wird in eine weiße %screengrab%-Box gepackt:

* Loading IRCd configuration ..
* Configuration loaded without any problems ..
* Loading tunefile..
* Initializing SSL.
* Dynamic configuration initialized .. booting IRCd. 

Der Code dazu:

%screengrab% [@
* Loading IRCd configuration ..
* Configuration loaded without any problems ..
* Loading tunefile..
* Initializing SSL.
* Dynamic configuration initialized .. booting IRCd. 
@]

In diesen drei Arten von Boxen sind keine Schriftformatierungen möglich!

Das soll es erstmal gewesen sein. Wie gesagt, zum Ausprobieren dieser Geschichten steht euch die Wiki Sandbox zur Verfügung. Weitere Informationen zum Thema Seitenbearbeitung gibt es unter Grundlagen der Bearbeitung?! Viel Spaß beim Ausprobieren!

Bearbeiten · Veränderungen zeigen · Druckansicht ·
Page last modified on May 23, 2011, at 09:38 PM