Hilfe: Formatierung

Aus LehramtsWiki
Wechseln zu: Navigation, Suche
Zeile 5: Zeile 5:
 
Das Design des LehramtsWiki erlaubt dir alle Artikel bequem auf dem Desktop-PC, deinem Smartphone und allem was dazwischen liegt, zu lesen. Deshalb ist es wichtig, dass du beim Bearbeiten und Erstellen der Artikeln darauf achtest, dass diese auch auf allen Geräten gut aussehen. Testen kannst du dies, indem du dein Browserfenster in der Breite veränderst und so die Ansicht auf einem Smartphone oder Tablet simulierst. Für Textformatierungen u. ä. reicht dieses Verfahren aus.
 
Das Design des LehramtsWiki erlaubt dir alle Artikel bequem auf dem Desktop-PC, deinem Smartphone und allem was dazwischen liegt, zu lesen. Deshalb ist es wichtig, dass du beim Bearbeiten und Erstellen der Artikeln darauf achtest, dass diese auch auf allen Geräten gut aussehen. Testen kannst du dies, indem du dein Browserfenster in der Breite veränderst und so die Ansicht auf einem Smartphone oder Tablet simulierst. Für Textformatierungen u. ä. reicht dieses Verfahren aus.
  
Da wir nicht wissen, wie breit und wie hoch der Bildschirm einer Benutzer*in ist, können wir nicht mit festen Größen arbeiten. Deshalb muss sämtlicher Inhalt anpassbar sein. Wir haben eine Hand voll Regeln aufgestellt, welche dir helfen sollen guten und anpassbaren Inhalt zu erstellen:
+
Da wir nicht wissen, mit welchem Gerät eine Benutzer*in arbeitet, muss sämtlicher Inhalt anpassbar sein. Wir haben eine Hand voll Regeln aufgestellt, welche dir helfen sollen guten und anpassbaren Inhalt zu erstellen:
 
* Benutze nur die hier genannten Wikitext Formatierungsmöglichkeiten.
 
* Benutze nur die hier genannten Wikitext Formatierungsmöglichkeiten.
 
* Vermeide Tabellen, wenn es geht. Falls du doch mal eine Tabelle setzen musst, erfährst du im Abschnitt [[#Tabellen|Tabellen]] wie das funktioniert.
 
* Vermeide Tabellen, wenn es geht. Falls du doch mal eine Tabelle setzen musst, erfährst du im Abschnitt [[#Tabellen|Tabellen]] wie das funktioniert.
 
* Lange Worte und lange Seitentitel benötigen etwas mehr Aufmerksamkeit. Mehr dazu erfährst du im Abschnitt [[#Lange Worte und lange Titel|Lange Worte und lange Titel]]
 
* Lange Worte und lange Seitentitel benötigen etwas mehr Aufmerksamkeit. Mehr dazu erfährst du im Abschnitt [[#Lange Worte und lange Titel|Lange Worte und lange Titel]]
 
{{HilfeseitenNavigation}}
 
  
 
==Wikitext Formatierungen==
 
==Wikitext Formatierungen==
Zum Bearbeiten von Artikeln steht nur ein einfacher texteditor zur Verfügung. Deshalb benötigen wir bestimmte Zeichen und Symbole um dem Wiki zu sagen, wie eine bestimmte Passage darzustellen ist. Dabei ist zu unterscheiden zwischen Zeichen und Symbolen für die Struktur des Dokumentes und einfachen Formatierungen für den Fließtext.
+
Zur Bearbeitung von Artikeln steht nur ein einfacher Texteditor zur Verfügung, deshalb benötigen wir bestimmte Zeichen und Symbole um dem Wiki zu sagen, wie eine bestimmte Passage darzustellen ist. Dabei unterscheiden wir zwischen Zeichen und Symbolen für die Struktur des Dokumentes und einfachen Formatierungen für den Fließtext.
  
 
===Den Artikel strukturieren===
 
===Den Artikel strukturieren===
Hierzu zählen Überschriften, diese geben auch die Struktur für das automatisch generierte Inhaltsverzeichnis wieder, und Listen:
+
Überschriften strukturieren den Text und geben die Struktur für das automatisch generierte Inhaltsverzeichnis wieder. Eine weiter Möglichkeit der Strukturierung sind Listen.
  
 
'''Überschriften''' werden durch Gleichheitszeichen markiert. Je mehr Gleichheitszeichen du verwendest, desto niedriger ist die Überschrift hierarchisch einzuordnen.
 
'''Überschriften''' werden durch Gleichheitszeichen markiert. Je mehr Gleichheitszeichen du verwendest, desto niedriger ist die Überschrift hierarchisch einzuordnen.
Zeile 25: Zeile 23:
 
  =====Überschrift 5=====
 
  =====Überschrift 5=====
 
  ======Überschrift 6, die letzte======
 
  ======Überschrift 6, die letzte======
Das '''Ergebnis''' dieser Eingabe wäre folgendes (beachte, wie diese Überschriften im Inhaltsverzeichnis eingefügt werden):
+
Das '''Ergebnis''' dieser Eingabe ist folgendes:  
 
=Überschrift 1=
 
=Überschrift 1=
 
==Überschrift 2==
 
==Überschrift 2==
Zeile 32: Zeile 30:
 
=====Überschrift 5=====
 
=====Überschrift 5=====
 
======Überschrift 6, die letzte======
 
======Überschrift 6, die letzte======
 +
Sieh dir an, wie diese Überschriften im Inhaltsverzeichnis rechts eingefügt werden.
  
'''Listen''' gibt es geordnet (1. 2. ...) und ungeordnet mit Spiegelstrich oder Punkt.
+
'''Listen''' gibt es geordnet, d. h. die einzelnen Punkte sind durchnummeriert, und ungeordnet mit Spiegelstrich oder Punkt.
 
  * ungeordneter Punkt
 
  * ungeordneter Punkt
 
  * weiterer ungeord. Punkt
 
  * weiterer ungeord. Punkt
Zeile 49: Zeile 48:
 
# zweiter Punkt
 
# zweiter Punkt
 
## geordneter Unterpunkt
 
## geordneter Unterpunkt
 +
  
 
===Formatierungen im Fließtext===
 
===Formatierungen im Fließtext===
Zeile 101: Zeile 101:
  
 
Diese Extension ersetzt dann den Titel der Seite durch die silbengetrennte Version innerhalb des ''titlehyphen'' Tags.
 
Diese Extension ersetzt dann den Titel der Seite durch die silbengetrennte Version innerhalb des ''titlehyphen'' Tags.
 +
 +
{{HilfeseitenNavigation}}
  
 
==Weiter in der Hilfe==
 
==Weiter in der Hilfe==
 
Jetzt hast du das nötige Rüstzeug für die nächste [[Hilfe:Links|Hilfeseite zum Thema Linksetzung]].
 
Jetzt hast du das nötige Rüstzeug für die nächste [[Hilfe:Links|Hilfeseite zum Thema Linksetzung]].
 
{{Fluid}}
 
{{Fluid}}

Version vom 22. Dezember 2021, 14:46 Uhr

Auf dieser Hilfeseite wird erklärt, wie Text im LehramtsWiki und anderen auf Mediawiki basierenden Wikis formatiert werden kann.

Ein paar Worte zu Beginn

Das Design des LehramtsWiki erlaubt dir alle Artikel bequem auf dem Desktop-PC, deinem Smartphone und allem was dazwischen liegt, zu lesen. Deshalb ist es wichtig, dass du beim Bearbeiten und Erstellen der Artikeln darauf achtest, dass diese auch auf allen Geräten gut aussehen. Testen kannst du dies, indem du dein Browserfenster in der Breite veränderst und so die Ansicht auf einem Smartphone oder Tablet simulierst. Für Textformatierungen u. ä. reicht dieses Verfahren aus.

Da wir nicht wissen, mit welchem Gerät eine Benutzer*in arbeitet, muss sämtlicher Inhalt anpassbar sein. Wir haben eine Hand voll Regeln aufgestellt, welche dir helfen sollen guten und anpassbaren Inhalt zu erstellen:

  • Benutze nur die hier genannten Wikitext Formatierungsmöglichkeiten.
  • Vermeide Tabellen, wenn es geht. Falls du doch mal eine Tabelle setzen musst, erfährst du im Abschnitt Tabellen wie das funktioniert.
  • Lange Worte und lange Seitentitel benötigen etwas mehr Aufmerksamkeit. Mehr dazu erfährst du im Abschnitt Lange Worte und lange Titel

Wikitext Formatierungen

Zur Bearbeitung von Artikeln steht nur ein einfacher Texteditor zur Verfügung, deshalb benötigen wir bestimmte Zeichen und Symbole um dem Wiki zu sagen, wie eine bestimmte Passage darzustellen ist. Dabei unterscheiden wir zwischen Zeichen und Symbolen für die Struktur des Dokumentes und einfachen Formatierungen für den Fließtext.

Den Artikel strukturieren

Überschriften strukturieren den Text und geben die Struktur für das automatisch generierte Inhaltsverzeichnis wieder. Eine weiter Möglichkeit der Strukturierung sind Listen.

Überschriften werden durch Gleichheitszeichen markiert. Je mehr Gleichheitszeichen du verwendest, desto niedriger ist die Überschrift hierarchisch einzuordnen.

=Überschrift 1=
==Überschrift 2==
===Überschrift 3===
====Überschrift 4====
=====Überschrift 5=====
======Überschrift 6, die letzte======

Das Ergebnis dieser Eingabe ist folgendes:

Überschrift 1

Überschrift 2

Überschrift 3

Überschrift 4

Überschrift 5
Überschrift 6, die letzte

Sieh dir an, wie diese Überschriften im Inhaltsverzeichnis rechts eingefügt werden.

Listen gibt es geordnet, d. h. die einzelnen Punkte sind durchnummeriert, und ungeordnet mit Spiegelstrich oder Punkt.

* ungeordneter Punkt
* weiterer ungeord. Punkt
** ungeordneter Unterpunkt

# geordneter Punkt
# zweiter Punkt
## geordneter Unterpunkt

Die Ausgabe wäre die folgende:

  • ungeordneter Punkt
  • weiterer ungeord. Punkt
    • ungeordneter Unterpunkt
  1. geordneter Punkt
  2. zweiter Punkt
    1. geordneter Unterpunkt


Formatierungen im Fließtext

Du kannst drei verschiedene Formatierungen einsetzen:

  • Fettdruck
  • Kursivdruck und
  • Absätze

Im folgenden Beispiel kommen alle drei Arten vor:

In einem '''Wiki''' kann man Texte ''kursiv'' schreiben.

Das Beste '''daran''' ist jedoch, dass man auch
''Absätze erstellen kann''.

Hier das Ergebnis:

In einem Wiki kann man Texte kursiv schreiben.

Das Beste daran ist jedoch, dass man auch Absätze erstellen kann.


Manchmal ist es hilfreich die automatische Generierung von Wikitext Formatierungen auszustellen. Wenn du einen Bereich mit <nowiki></nowiki> einklammerst, so werden dort keine Formatierungen angewandt.

<nowiki>Inhalt '''ohne''' Format.</nowiki>

Ausgabe:

Inhalt '''ohne''' Format.


Vielleicht sind dir die blau-grauen Boxen auf dieser Seite aufgefallen. Diese erscheinen sobald du ein Leerzeichen zu Beginn einer Zeile lässt.

Hier ist das erste Zeichen ein Leerzeichen.
Deshalb wird dieser Kasten angezeigt.
Er enthält keine strukturellen
Formatierungen. Fettdruck u.ä.
funktionieren weiterhin.

Tabellen

Wir haben einen Weg gefunden, Tabellen für alle Gerätegrößen passabel darzustellen. Leider ist die Erstellung von Tabellen dadurch etwas aufwändiger geworden, daher haben wir einen eigenen Artikel angelegt, welcher sich mit der Erstellung von anpassbaren Tabellen beschäftigt. Weiterhin gilt der Grundsatz, dass Tabellen eher vermieden werden sollten.

Lange Worte und lange Titel

Hin und wieder kommt es vor, dass überdurchschnittlich lange Worte gebraucht werden, sowohl im Fließtext als auch im Titel einer Seite. Für Fließtext lässt sich dieses Problem ziemlich leicht lösen: Wir haben ein langes Wort, bspw. Antioxidationsmittelaufbewahrungskästchen. Mithilfe des Tags &shy; lässt sich dieses Wort in Silben oder zumindest Umbruchpunkte zerteilen. In fertigem Wikitext könnte ein solches Wort so aussehen:

Antioxidations&shy;mittel&shy;aufbewahrungs&shy;kästchen

Wenn lange Worte in Titeln auftauchen, kann eine Extension benutzt werden, um einen alternativen Titel anzugeben. Sagen wir, wir haben den gleichen Titel wie gerade im Namensraum Vorlage:. Füge in die erste Zeile deines Wikitextes folgende Zeile ein:

<titlehyphen>Antioxidations&shy;mittel&shy;aufbewahrungs&shy;kästchen</titlehyphen>

Wenn der Titel einen Schrägstrich enthält wie auf der Seite "Course Catalog/​Information Package", ist der Teil "Catalog/​Information" zu lang um mobil vernünftig dargestellt zu werden. Also wäre es nötig nach dem "/" ein Leerzeichen einzufügen, was allerdings in der normalen Ansicht falsch aussieht. Die Lösung hierfür ist ein Leerzeichen, welches keine Breite hat. Dieses kann durch &#8203; erzeugt werden. Im Gegensatz zu &shy; wird hierdurch im Falle eines Umbruchs kein Bindestrich generiert.

<titlehyphen>Course Catalog/&#8203;Information Package</titlehyphen>

Diese Extension ersetzt dann den Titel der Seite durch die silbengetrennte Version innerhalb des titlehyphen Tags.


Weiter in der Hilfe

Jetzt hast du das nötige Rüstzeug für die nächste Hilfeseite zum Thema Linksetzung.