Ausführliche Darstellung zur Verwendung von PHP Markdown Extra

PHP Markdown Extra ist eine spezielle Erweiterung des PHP Markdown. PHP Markdown Extra verfügt über einige nützliche Erweiterungen gegenüber dem "normalen" Markdown, der Standardvariante. Um die geht es hier als erstes. Danach rkläre ich die Zusätze.

Markdown Standard

Überschriften

Überschriften kann man auf zweierlei Art und Weise erzeugen:

  • durch eine beliebe Anzahl von --- bzw. ==== nach dem eigentlichen Überschriftentext können h1- bzw. h2-Überschriften erzeugt werden.
  • durch # , ## bis ###### am Anfang der Zeile vor dem eigentlichen Überschriftentext können h1, h2 bis h6 Überschriften erzeugt werden.

Beispiel Überschrift

##### So wird eine H5-Überschrift erzeugt

ergibt

So wird eine H5-Überschrift erzeugt

Zitate

Die Darstellung für Zitatabschnitte wird erreicht, indem dem Textabschnitt ein > vorangestellt wird. Doppelt >> ergibt sich ein Zitat des Zitates usw. Im HTML-Code wird dann <blockquote></blockquote> erzeugt.

Beispiel Zitat

> Hier zitiere ich etwas

Hier zitiere ich etwas

>> Hier zitiere ich ein Zitat

Hier zitiere ich ein Zitat

Listen

Ungeordnete Listen werden mit einem _*_ am Anfang der Zeile erzeugt, geordnete Listen, also solche mit numerischer Aufzählung durch _1._, _2._ usw. am Anfang der Zeile. Bei ungeordneten Listen sind aber auch andere Zeichen am zeilenbeginn möglich, bspw. +, -

Beispiele Listen

* Auf
* zäh
* lung

erzeugt

  • Auf
  • zähl
  • lung

und

1. Auf
2. zäh
3. lung

erzeugt

  1. Auf
  2. zähl
  3. lung

Markdown Extra

Nach den Ausführungen zur Markdown Grundvariante stelle ich nun die Erweiterungen von Markdown Extra vor.

Code mit Markdown Extra

Code oder kein Code

Definitionslisten mit Markdown Extra

Apple
Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
Orange
The fruit of an evergreen tree of the genus Citrus.

Fussnoten mit Markdown Extra

PHP Markdown Extra verfügt über einen speziellen Fussnotenmechanismus. Dazu wird hinter dem mit einer Fussnote zu versehenden Text in eckigen Klammern das Carret-Zeichen gefolgt von einer Ziffer eingegeben. Der eigentliche Fussnotentext wird erzeugt, in dem die gleiche Zeichenfolge, gefolgt von einem Doppelpunkt am Anfang der Zeile stehen, danach folgt der Fussnotentext. Markdown extra erzeugt automatisch am Ende des Dokumentes einen speziellen Fussnotenabschnitt, der etwa so aussieht:

<div class="footnotes">
<hr>
  <ol>
    <li id="fn:1">
      <p>Erste Fussnote.&nbsp;
        <a rev="footnote" href="#fnref:1">↩</a>
      </p>
    </li>
    <li id="fn:2">
      <p>Zweite Fusnote.&nbsp;
        <a rev="footnote" href="#fnref:2">↩</a>
      </p>
    </li>
  </ol>
</div>

Diesen Abschnitt kann man durch entsprechende CSS-Anweisungen nach eigenen Wünschen formatieren. Das Backlinkzeichen in der Fussnote () ist allerdings direkt im PHP-Code des Markdown-Parsers festgelegt.

Beispiel Fussnoten mit Markdown Extra

Dieser Text hat die 1. Fussnote.1 Dieser Text hat die 2. Fussnote.2

Abkürzungen mit Markdown Extra

Markdown kann auch mit sogenannten Abkürzungen umgehen. Diese entsprechen dem <abbr></abbr>-Tag. Diese werden erzeugt, in dem man, beginnend direkt am Anfang einer Zeile, Code nach diesem Muster einfügt: *[Abkürzung]: Abkürzungserklärung. Bei diesen Abkürzungen wird zwischen Groß- und Kleinschreibung unterschieden, daher wird markdown wird nicht erklärt.

Beispiel Abkürzungen mit Markdown Extra

Auf dieser Seite ist das Wort Markup mit einer Abkürzungserklärung versehen, also *[Markdown]: Markdown ist nicht Markup.

Tabellen mit Markdown Extra

Item Value
Computer $1600
Phone $12
Pipe $1
Item Value
Computer $1600
Phone $12
Pipe $1
Item Value
Computer $1600
Phone $12
Pipe $1

  1. Erste Fussnote. 

  2. Zweite Fusnote.