Wiki-Syntax Teil 3: Spezielle Textauszeichnungen

Anfänger 2018 Jun 15 (23:01) 0
Mit der in JBerries verwendeten Wiki-Syntax können Links auf Inhalte von JBerries und auf spezielle Kapitel-Überschriften gesetzt werden. Externe Links werden dagegen nur im Klartext dargestellt. Beim Einbinden von Graphiken muss zwischen üblichen Graphik-Formaten (wie jpg oder png) und Vektorgraphiken (svg) unterschieden werden.

Ein Link besteht immer aus zwei Elementen:

Label
der Text, der später als Link dargestellt wird.
Adresse
die URL, zu der der Link führen soll.

Innerhalb der Inhalte von JBerries können — je nach Adresse des Links — drei verschiedene Links erzeugt werden, für die dann jeweils andere Regeln gelten:

Art des Links Beschreibung
Links innerhalb von JBerries Links auf andere Inhalte, die sich innerhalb von JBerries befinden
Links innerhalb eines Artikels Link auf eine Kapitel-Überschrift innerhalb eines Inhaltes von JBerries
Externe Links Links auf Inhalte außerhalb von JBerries

In den folgenden Abschnitten wird beschrieben, wie man diese drei Arten von Links erzeugt und wie sie dargestellt werden.

Setzt man einen Link zu einer anderen Seite, die sich innerhalb von JBerries befindet, gibt es zwei Möglichkeiten:

  1. der Link führt zu einer Seite
  2. der Link führt zu einer Überschrift innerhalb der Seite.

Vorerst wird nur die erste Möglichkeit beschrieben, wie man den Link speziell auf eine Überschrift setzt, wird im nächsten Abschnitt erklärt.

Der Link besteht aus Adresse und Label, wobei die Adresse in zwei Teile aufgespalten werden kann:

  1. die Basis-URL und
  2. dem Pfad.

Beispielsweise besitzt der Artikel Einführung in die Informatik die Adresse

https://de.jberries.com/artikel/einführung-in-die-informatik-8

Um einen Link auf diese Seite zu setzen, empfiehlt es sich natürlich als Label den Titel Einführung in die Informatik zu verwenden (aber das Label ist frei wählbar). Die einzelnen Bestandteile des Links sind somit:

Label Einführung in die Informatik
Adresse https://de.jberries.com/artikel/einführung-in-die-informatik-8
Basis-URL https://de.jberries.com/artikel/
Pfad einführung-in-die-informatik-8

Und der Link wird im Wiki-Text geschrieben als

[https://de.jberries.com/artikel/einführung-in-die-informatik-8 Einführung in die Informatik]

Das heißt Adresse und Label werden — durch ein Leerzeichen getrennt — in eckige Klammern geschrieben:

[Adresse Label]

Die Adresse eines Inhaltes von JBerries kann beim Anzeigen des Inhaltes im Browser aus der Adresszeile kopiert werden.

Soll eine Überschrift innerhalb eines Artikels durch einen Link angesprochen werden, gibt es zwei Möglichkeiten:

  • absoluter Link
  • relativer Link.

Der absolute Link wird ganz ähnlich gebildet wie ein Link zu einem anderen Inhalt innerhalb von JBerries, der relative Link ist einfacher; beide werden im Folgenden beschrieben.

Besitzt ein Artikel soviele Überschriften, so dass ein Inhaltsverzeichnis erzeugt wird, können alle Überschriften über einen Link angesprochen werden. Dies wird durch die id ermöglicht, die die Überschriften besitzen. Klickt man eine Überschrift in einem Inhaltsverzeichnis an, erscheint in der Adresszeile des Browsers die Adresse des Artikels zusammen mit der id ; beide sind durch das Zeichen # getrennt.

Beispielsweise besitzt der Artikel Elementare Syntax von C++: Schleifen das Kapitel for-Schleifen (mit Zählvariable). Klickt man diese Überschrift an, erscheint in der Adresszeile des Browsers:

https://de.jberries.com/artikel/elementare-syntax-von-c++-schleifen-36#for-schleifen_mit_zählvariable

Um einen Link auf dieses Kapitel zu erzeugen, schreibt man in Wiki-Syntax (dabei wird als Label die Kapitel-Überschrift verwendet):

[https://de.jberries.com/artikel/elementare-syntax-von-c++-schleifen-36#for-schleifen_mit_zählvariable for-Schleifen (mit Zählvariable)]

Ein Link auf ein mit einer id versehenen Kapitel-Überschrift, besitzt also die Form:

[Adresse#id Label]

Man erkennt an diesem Beispiel:

  1. Links innerhalb eines Artikels auf eine spezielles Kapitel unterscheiden sich nicht von Links auf spezielles Kapitel eines anderen Artikels.
  2. Um innerhalb eines Artikels Links auf Kapitel setzen zu können, benötigt man die Adresse des Artikels. Das heißt aber, dass man den Artikel zuerst veröffentlichen muss, da erst dann seine Adresse erzeugt wird. (Zum Setzen der Links muss man den Artikel neu editieren.)

Achtung: Gibt es mehrere Kapitel-Überschriften mit identischem Text, so besitzen die Überschriften jeweils die identische id und der Link zeigt auf die erste Überschrift.

Bei einem relativen Link innerhalb eines Artikels ist die Adresse des aktuellen Artikels nicht nötig; es reicht die id der Überschrift zu kennen, die angesprochen werden soll.

Der Wiki-Text, um eine Überschrift mit einer gewissen id durch ein Label anzusprechen, lautet:

[#id|Label]

Man beachte:

  • Vor der id benötigt man das Zeichen # .
  • die id kann man wie oben beschrieben mit Hilfe des Browsers feststellen.
  • Als Trennungszeichen zwischen id und Label muss | verwendet werden und nicht das Leerzeichen wie beim absoluten Link.

So besitzt dieser Artikel zum Beispiel die Überschrift Links mit der id : links . Der relative Link zu dieser Überschrift wird mit

[#links|Links]

gebildet; der Name des Labels ist zwar wieder frei wählbar, aber mit Links treffend gewählt.

Dargestellt wird dieser Link dann durch Links.

Ein Link, der auf eine URL außerhalb von JBerries verweist, wird als externer Link bezeichnet. Er wird nicht als Link sondern im Klartext dargestellt.

Es gibt jetzt wieder zwei Möglichkeiten:

  1. der externe Link besteht nur aus einer Adresse
  2. der externe Link besteht aus einer Adresse und einem Label.

Im ersten Fall wird die Adresse in eckige Klammern [] eingeschlossen:

[http://www.partnersofjberries.com]

Dargestellt wird der Link als http://www.partnersofjberries.com.

Im zweiten Fall werden wieder Adresse und Label in eckige Klammern [] eingeschlossen und durch ein Leerzeichen getrennt:

[http://www.partnersofjberries.com Partners of JBerries]

Dargestellt wird der Link durch Partners of JBerries (http://www.partnersofjberries.com).

Bilder

Bei Bildern muss man zwischen

  • Vektorgraphiken im Format .svg (scalable vector graphics) und
  • anderen Graphik-Formaten unterscheiden.

Die Wiki-Syntax ist leicht unterschiedlich. Bei beiden kann eine Bildbeschreibung eingefügt werden, die dann deutlich als solche zu erkennen ist. Aber nur bei den anderen Graphik-Formaten kann das alt-Attribut gesetzt werden.

In der Bildbeschreibung können aber keinerlei Textauszeichnungen (wie fetter Text, kursiver Text oder Links) eingesetzt werden.

Das Hochladen der Bilder und das Einfügen der Wiki-Syntax, um ein Bild darzustellen, wird durch den Editor so weit unterstützt, dass man auch ohne die im Folgenden beschriebenen Einzelheiten zurechtkommen sollte.

Vektorgraphiken

Beim Hochladen einer Vektorgraphik im Tab Bilder erscheint — sofern das Hochladen erfolgreich war — die Graphik und deren id . Aus der id und einer Beschreibung des Bildes lässt sich der Wiki-Text formen:

[[Svg:id|Beschreibung]]

So wird zum Beispiel das folgende Bild

Abbildung 1: ZehneckAbbildung 1: Zehneck

durch

[[Svg:36|Abbildung 1: Zehneck]]

erzeugt.

Andere Graphik-Formate

Beim Hochladen von Bildern in anderen Graphik-Formaten gibt es keinen Unterschied zu Vektorgraphiken — jede Graphik erhält eine id . Die Wiki-Syntax lautet jetzt allerdings:

[[Image:id|caption]]
[[Image:id|alt|caption]]

Im ersten Fall wird nur die Bildbeschreibung gesetzt; diese wird zugleich für das alt-Attribut verwendet.

Im zweiten Fall wird das alt-Attribut ausdrücklich gesetzt.

Die folgenden zwei Bilder

Abbildung 2: Was siehst Du?Abbildung 2: Was siehst Du?

JCatAbbildung 3: Was siehst Du?

besitzen die id 3 beziehungsweise 4. Beim ersten Bild ist kein alt-Attribut gesetzt, beim zweiten Bild wird JCat als alt-Attribut gesetzt.

Der Wiki-Text zum Einbinden der Bilder lautet:

[[Image:3|Abbildung 2: Was siehst Du?]]
[[Image:4|JCat|Abbildung 3: Was siehst Du?]]

Unterstützung durch den Editor

Der Editor besitzt die drei Ansichten

  • Übersicht
  • Inhalt
  • Bilder.

Zum Hochladen von Bildern geht man zur Ansicht Bilder; das eigentliche Hochladen bedarf keiner Erklärung. Hier gibt es keinen Unterschied zwischen Vektorgraphiken und anderen Graphik-Formaten. Sobald ein Bild erfolgreich hochgeladen wurde, erscheint die id des Bildes und ein Vorschaubild.

Zum Einfügen des Bildes in einen Artikel geht man wieder zur Ansicht Inhalt und erzeugt mit der id den Wiki-Text wie oben erklärt. Man kann dies auch Abkürzen, indem man den Cursor an der Stelle des Wiki-Textes plaziert, an der das Bild eingefügt werden soll und im Editor Select Image auswählt. Jetzt erscheinen Vorschaubilder aller hochgeladener Bilder, von denen man das gewünschte Bild anklickt. Dadurch wird der Wiki-Text mit der entsprechenden id erzeugt; die Bildbeschreibung und das alt-Attribut sollte man noch anpassen.

Alle Kommentare
Durch die Nutzung dieser Website erklären Sie sich mit der Verwendung von Cookies einverstanden. Außerdem werden teilweise auch Cookies von Diensten Dritter gesetzt. Genauere Informationen finden Sie in unserer Datenschutzerklärung sowie im Impressum.