Hilfe:Formatierungen: Unterschied zwischen den Versionen

Aktuelle Version vom 28. März 2020, 23:18 Uhr

Portal: Hilfe

In diesem Tutorial wird das Formatieren eines Artikels im KingWiki erklärt.

Unter Formatierungen werden optische Gestaltungselemente verstanden, die im KingWiki verwendet werden. Hierzu werden die im Folgenden näher erklärten Gestaltungsmittel gezählt. In diesem Zusammenhang werden auch wichtige Hinweise gegeben, wie diese Formatierungen normalerweise verwendet werden.

Für ein besseres Verständnis hilft die Vorstellung, dass jede Formatierung durch eine Zeichenfolge erzeugt wird, die jeweils vor und hinter der betroffenen Wortgruppe steht; sie praktisch umklammert. Jeder Formatierungsbefehl muss also eingeleitet und abgeschlossen werden, wobei der dazwischen stehende Text formatiert wird.

Fette Schrift

Fette Schrift lässt sich durch drei Apostrophe erzeugen, die jeweils vor und hinter einem Wort oder einer Wortgruppe stehen.

Dieser Text wird '''fett''' angezeigt.
Dieser Text wird fett angezeigt.

Diese Methode soll sparsam verwendet werden. In der Regel beschränkt sich die Fettschrift auf die Einleitung eines Artikels, wobei der in der Einleitung genannte Artikelname fett dargestellt wird. Sie dient auch als optische Orientierungshilfe, die teilweise in Infoboxen und Listen für eine schnellere Erfassung hilft.

Kursive Schrift

Kursive Schrift lässt sich durch zwei Apostrophe erzeugen, die jeweils vor und hinter einem Wort oder einer Wortgruppe stehen.

Dieser Text wird ''kursiv'' angezeigt.
Dieser Text wird kursiv angezeigt.

Kursive Schrift wird meistens für die Heraushebung von Werken in einem Text verwendet. Beispielsweise bei Carrie, wobei die Apostrophe außerhalb der Link-Klammern stehen. Ferner dient die kursive Schrift als Betonungshilfe innerhalb eines Textes, der unter anderen Umständen falsch interpretiert werden könnte.

Interne Links

Interne Links sind mit je zwei eckigen Klammern vorn und hinten zu setzen:

[[Leland Gaunt]] ergibt den Link Leland Gaunt.

Geht es um einen zu verlinkenden Titel, wird er zusätzlich mit Apostrophen versehen:

''[[In einer kleinen Stadt]]'' ergibt somit In einer kleinen Stadt.

Kapitelüberschriften

Kapitel teilen einen Artikel in mehrere Abschnitte ein, damit der Leser schneller sieht, in welchem Teil des Artikels eine gesuchte Information zu erwarten ist. Kapitel werden erzeugt, indem der gewünschte Kapitelname von beiden Seiten mit Ist-gleich-Zeichen versehen wird. Standardgemäß sind das 2 Ist-gleich-Zeichen auf beiden Seiten. Kapitel, die diesen Kapiteln untergeordnet werden sollen, erhalten 3 Zeichen. 4 Zeichen erzeugen eine dritte Ebene - diese sollten jedoch eher die Ausnahme sein.

== Kapitel 1 ==
=== Kapitel 1.1 ===
=== Kapitel 1.2 ===
==== Kapitel 1.2.1 ====
==== Kapitel 1.2.2 ====
== Kapitel 2 ==

Absätze

Absätze werden durch einen doppelten Klick auf die Entertaste erzeugt. Im Quelltext steht zwischen zwei Textabschnitten dann eine Leerzeile. Ein einfacher Druck auf die Entertaste erzeugt einen Absatz, der zwar im Quelltext sichtbar ist, aber nicht im angezeigten Artikeltext.

Dazu einige Richtlinien:

• Die Einleitung eines Artikels besteht aus einem erklärenden Satz, nach dem meist ein Absatz kommt.
• Absätze sollten nicht zu kurz und nicht zu lang sein. Außer der Einleitung sollte jeder Absatz mindestens aus zwei Sätzen bestehen.
• Mit Absätzen können unabhängige Inhalte voneinander getrennt werden, die dennoch im selben Kapitel stehen sollen.

Textausrichtung

Der Text kann auch zentriert auf dem Bildschirm dargestellt werden.

 <center>zentrierter Text</center> 

Auch diese Methode sollte mit Bedacht verwendet werden, da zentrierter Text Probleme mit Bildern schaffen kann.

Zitierfelder

Für längere Zitate (über mehrere Zeilen) eignet sich ein Zitierfeld, das den zu zitierenden Text optisch vom sonstigen Artikeltext abhebt.

{{cquote|Text|||Fundort}}

	Aus einer Höhe von zweitausend Fuß, wo Claudette Sanders gerade eine Flugstunde nahm, leuchtete die Kleinstadt Chester's Mill im Morgenlicht, als wäre sie frisch hergestellt und eben erst dorthin verfrachtet worden.
—Kapitel 1

Listen

Immer dann, wenn Dinge aufgelistet werden sollen, die sich nicht oder nur sehr umständlich in einem Fließtext darstellen lassen, nutzen wir im Wiki die Listen. Dabei gibt es keine Begrenzung, wie lang diese sein können. Egal, ob kurze Listen (Familie Debusher), oder sehr lange Listen (Das letzte Gefecht/Schauplätze), es gibt genügend Gelegenheiten, bei denen die Auflistung genutzt wird.

Die Mediawiki-Software bietet unterschiedliche Wege an um verschiedene Listen zu erzeugen. Hier die Übersicht:

Unnummerierte Listen

Auch unsortierte Listen genannt. Die Form der Auflistung wird bei uns hauptsächlich eingesetzt. Der Text wird etwas eingerückt und ein Punkt davorgesetzt. Um die Listen zu erstellen, reicht es einen Stern am Anfang der Zeilen im Quelltext zu setzen, welche die Listenelemente darstellen.

* Ich bin ein Punkt
* Ich bin der zweite Punkt

wird so zu

• Ich bin ein Punkt
• Ich bin der zweite Punkt

Auch Unterpunkte der Elemente können erstellt werden.

* Ich bin ein Punkt
** Ich bin ein Unterpunkt
*** Ich bin ein Unter-Unterpunkt
**** Ich bin ein unterer Unter-Unterpunkt
* Ich bin der zweite Punkt

wird zu

• Ich bin ein Punkt
  • Ich bin ein Unterpunkt
    • Ich bin ein Unter-Unterpunkt
      • Ich bin ein unterer Unter-Unterpunkt
• Ich bin der zweite Punkt

Bei Unterpunkten ist es wichtig, keine Leerzeile zwischen den Listenelementen zu lassen. Sonst 'denkt' die Software, es soll eine komplett neue Liste generiert werden und fügt vor die Unterpunkte leere Punkte ein.

* Ich bin ein Punkt
** Ich bin der erste Unterpunkt

** Ich bin eigentlich der zweite Unterpunkt

wird so zu

• Ich bin ein Punkt
  • Ich bin der erste Unterpunkt

• • Ich bin eigentlich der zweite Unterpunkt

Leerzeilen bei den obersten Punkten sind kein Problem. Die Software erstellt zwar weiterhin neue Listen, aber das fällt beim Lesen und beim editieren nicht auf und dient anderen Bearbeitern der Listen sogar der Übersichtlichkeit.

nummerierte Listen

Wenn eine Reihenfolge klar erkenntlich gemacht werden soll, machen sich nummerierte Listen besser. Die Art und Weise ist dem der unnummerierten Listen gleich, nur das Sonderzeichen am Zeilenanfang ist anders. Im Gegensatz zum Stern ist der Hashtag/ die Raute zu nutzen.

# Ich bin der erste Punkt
## Ich bin der erste Unterpunkt
## Ich bin der zweite Unterpunkt
## Ich bin der dritte Unterpunkt
# Ich bin der zweite Punkt

wird zu

1. Ich bin der erste Punkt
   1. Ich bin der erste Unterpunkt
   2. Ich bin der zweite Unterpunkt
   3. Ich bin der dritte Unterpunkt
2. Ich bin der zweite Punkt

Wichtig hier: Im Gegensatz zu den unnummerierten Listen, dürfen in keinem Fall Leerzeilen entstehen, sonst fängt die Nummerierung wieder bei 1 an. Ausnahmen sind natürlich Listen, wo genau das gewollt ist.

Definitionslisten

Wie der Begriff schon andeutet, werden Definitionslisten verwendet, wenn Elemente erklärt werden sollen. Wir nutzen diese Listen hauptsächlich bei Charakteren und Schauplätzen (z.B.: New_York_), die in mehreren Werken vorkommen, um diese aufzulisten, ohne große Überschriften zu erstellen. Der Begriff wird dabei fett dargestellt und die Erklärung dazu darunter etwas eingerückt.

Die Syntax ist nicht kompliziert. Vor den fett darzustellenden Begriff kommt ein Semikolon. Der Erklärtext wird mit einem Doppelpunkt eingerückt, wie er auch auf Diskussionsseiten verwendet wird.

; Ich bin der Begriff
: Ich bin die Erklärung

Wird zu

Ich bin der Begriff

Ich bin die Erklärung

Benötigt man mehrere Textabsätze für die Erklärung, so kann man vor jeden der Abschnitte einen Doppelpunkt setzen. Es ist natürlich auch möglich, den Begriff ohne die Erklärung zu schreiben. Allerdings sollte bei dieser Art der Formatierung besser eine Überschrift mit den '=' verwendet werden.

Ein Hinweis: Mitunter steht die gesamte Syntax auch in einer Zeile. Das macht der Software nichts aus, ist aber nicht so übersichtlich für die nachfolgenden Bearbeiter der Liste.

; Ich bin der Begriff: Und ich die Erklärung

Wird ohne Probleme so dargestellt

Ich bin der Begriff

Und ich die Erklärung.

Da sich Semikolon und Doppelpunkt optisch nicht sehr unterscheiden, empfiehlt sich bei Definitionslisten - im Gegensatz zu den beiden anderen Formen vorher - das Leerzeichen zwischen zwei Einträgen. Gerade bei langen Listen oder viel Fließtext zur Erklärung des Punkts geht die Übersicht sonst schnell verloren.

Zur Verwendung der Listen

Wann verwende ich welche Listen?

• Unsortierte Listen sind im Zweifel immer die beste Wahl.
• Wenn es eine klare Reihenfolge gibt, bei Anleitungen, oder Schrittfolgen, können nummerierte Listen besser sein. Wichtig hier ist wohl, dass keine Lücken enthalten sind
• Bei einem Glossar, oder einer Auflistung, bei der Schlüsselwörter wichtig sind, machen Definitionslisten am meisten Sinn.

Ganz allgemein: Schau' dir mit Hilfe der Vorschaufunktion an, was am besten aussieht. Mitunter erkennt man die optisch beste und am leichtesten zu lesende Form erst, wenn man ein paar Punkte der Listen erstellt hat. Mitunter hilft es auch, ein wenig am Text der Listenelemente zu arbeiten. Manchmal zeigt sich, dass eine Definitionsliste doch besser ist. Scheue dich auch nicht davor zurück, ganz auf Listen zu verzichten. Fließtext, in denen die Dinge in ganzen Sätze aufgelistet werden, macht mitunter auch Sinn. Oder aber, eine Tabelle bringt die Informationen schneller und übersichtlicher näher.

Kann ich Listen mischen?

Theoretisch ja, optisch sieht das aber nicht schön aus.

; Ich bin ein Begriff
* Ich bin der erste Unterpunkt

wird zu

Ich bin ein Begriff

• Ich bin der erste Unterpunkt

und ist noch in Ordnung.

* Ich bin ein Punkt
:* Ich bin eigentlich ein Unterpunkt

sollte aber nicht verwendet werden. Es mag zwar für den Leser nicht weiter auffallen, ist aber der falsche Weg. Stattdessen sollten zwei Sterne für Unterpunkte verwendet werden.

und sonst noch?

Der Übersicht halber empfiehlt sich ein Leerzeichen zwischen den Sonderzeichen und dem Text dahinter. Technisch ist das zwar nicht notwendig und wurde in der Vergangenheit bei vielen Listen auch nicht umgesetzt, aber bei langen Listen erkennt man so schneller die Einzelpunkte.

Listen auf Spalten aufteilen

Es gibt einige Listen, die zwar viele Elemente enthalten, deren Inhalt aber sehr kurz ist. Optisch geht sehr viel Platz auf der rechten Seite des Schirms verloren, während man sehr lange nach unten scrollen muss, um alle Elemente durchzulesen. Es gibt Mittel und Wege, die Listen auf zwei oder mehrere Spalten aufzuteilen.

Allerdings erfordert das bisher erweiterte Kenntnisse in HTML und speziell in CSS. Wer sich darin sicher genug fühlt, findet hier und hier Beispiele für die zwei Varianten als Vorlage, die wir im KingWiki einsetzen.

Das erste Beispiel kann verwendet werden, wenn der Spaltenumbruch nach der Hälfte der Elemente passieren soll. Das zweite Beispiel demonstriert Spalten, bei denen die Elemente von Links nach Rechts priorisiert gelistet werden. Der Unterschied anhand einer kurzen Liste.

Methode 1

Methode 2

• A
• B
• C
• D

Ein paar Hinweise dazu:

• Beim Einsatz von mehreren Spalten solltet ihr darauf achten, dass das KingWiki auch auf kleinen Bildschirmen dargestellt wird. Je mehr Spalten im Einsatz sind, desto schneller entsteht ein horizontaler Scrollbalken, den wir vermeiden wollen. Außerdem entstehen bei wenig Platz auf diese Art schmale Einzelelemente über viele Zeilen, die eventuell nur aus einzelnen Wörtern bestehen. Empfehlenswert sind daher vorrangig zwei Spalten als Maximum.
• Durch die Verwendung von HTML- und CSS-Quelltext kann es sehr schnell dazu kommen, dass ungeübte Bearbeiter die Übersicht verlieren. Jede Methode hat ihre Eigenheiten, die unbedingt beachtet werden müssen, damit die Liste, und teilweise auch der gesamte Artikel richtig dargestellt wird. Daher empfiehlt sich hier ein sparsamer Einsatz und eine ausführliche Hilfestellung im Quelltext durch HTML-Kommentare <!-- auf diese Art --> um die Bearbeitung und Erweiterung zu unterstützen.