Page tree
Skip to end of metadata
Go to start of metadata

Einführung

Markdown ist eine effiziente Auszeichnungssprache mit einer simplen Syntax, die für die Formatierungsdarstellungen von Texten und anderen Daten verwendet wird. Markdown wird für eine schnelle Verarbeitung und Auszeichnung von Textdaten eingesetzt, um daraus HTML zu generieren, die zum Beispiel im World Wide Web fehlerfrei und HTML-konform angezeigt werden sollen. Um ein markdown-konformes Dokument darzustellen wird die einfache Syntax angewendet, die so ausgelegt ist, dass der Informationstext schon in der Ausgangsform (vor der eigentlichen Konvertierung) für jeden gut lesbar ist. Insbesondere setzt Markdown dafür Satzzeichen und viele äquivalente Methoden ein. Die Syntax von Markdown wurde bewusst aus bestehenden Zeichen definiert. Das bedeutet, dass die Visualisierung der Zeichen auch ihrer Semantik entspricht.

Einsatz im C4

Im CLARC Configuration Center (C4) wird mittels Markdown die Kontexthilfe für den Benutzer bereitgestellt. Die Kontexthilfe besteht aus wichtigen Informationen, die in Form von Text auf der rechten Seite im C4 dargestellt werden. Über Markdown wird der formatierte HTML-Code der Kontexthilfe im C4 generiert. Dem Benutzer dient die Kontexthilfe als Hilfestellung.

Tipp

Über das C4 Hauptmenü kann die dynamische Kontexthilfe eingeblendet werden. Wählen Sie dazu im View-Menü die Option Context Help aus.

Anwendung von Markdown

Markdown kann wie folgt verwendet werden:

Absätze

Um einen einfachen Absatz aus einer oder mehreren Textzeilen mit Markdown darstellen zu können, wird nach dem letzten Satz des Absatzes eine Leerzeile erzeugt.

Zeilenumbruch

Ein Zeilenumbruch entspricht einer normalen Zeilenschaltung (Return).

Überschriften

Für die Überschriften werden zwei Arten von Formatierungsmöglichkeiten unterstützt. Überschriften im Setext-Format werden auf der ersten Ebene mit Gleichheitszeichen dargestellt. Hierbei werden die Zeichen unter die jeweiligen Zeilen hinzugefügt, dabei ist die Anzahl der Zeichen unbedeutend. Für eine zweite Ebene wird die Kopfzeile mit einem Bindestrich versehen. Aus diesem Format können nur zwei Überschriften generiert werden. Bei dem Axt-Format werden 1-6 Rauten an den Anfang der Zeile gesetzt. Die Anzahl der Rauten gibt dabei die Ebene an. Für die dritte Ebene werden also drei Rauten hinzugefügt.

Beispiel im Setext-Format:

MarkdownHTMLErgebnisInfo
CTO Balzuweit
=================

<h1>CTO Balzuweit</h1>

CTO Balzuweit

Die Überschrift h1 hat Schriftgröße 24.
CLARC ENTERPRISE
-------------------
<h2>CLARC ENTERPRISE</h2>

CLARC ENTERPRISE

Die Überschrift h2 hat Schriftgröße 18

Bei dem Axt-Format werden 1-6 Rauten an den Anfang der Zeile gesetzt. Zwischen der Raute und der Überschrift muss ein Leerzeichen hinzugefügt werden.Die Anzahl der Rauten gibt dabei die Ebene an. Für die dritte Ebene werden also drei Rauten hinzugefügt. Im Unterschied zu dem Setext-Format können hier mehrere Überschriften generiert werden.

Beispiel im Axt-Format:

# CTO Balzuweit GmbH

<h1>CTO Balzuweit GmbH</h1>

CTO Balzuweit GmbH

Die Überschrift h1 hat Schriftgröße 24.
## CLARC ENTERPRISE

<h2>CLARC ENTERPRISE</h2>

CLARC ENTERPRISE

Die Überschrift h2 hat Schriftgröße 18.
### CLARC Config Center

<h3>CLARC Config Center</h3>

CLARC Configuration Center

Die Überschrift h3 hat Schriftgröße 13,5.
#### CLARC EWORK
<h4>CLARC EWORK</h4>

CLARC EWORK

Die Überschrift h4 hat Schriftgröße 12.
##### CLARC XTRACT
<h5>CLARC XTRACT</h5>

CLARC XTRACT

Die Überschrift h5 hat Schriftgröße 10.
###### CLARC XCONTROL
<h6>CLARC XCONTROL</h6>CLARC XCONTROLDie Überschrift h6 hat Schriftgröße 7,5.

Schriftformartierungen

Damit wichtige Informationen auch hervorgehoben werden können besteht die Möglichkeit den Text Kursiv, Fett oder Fett und Kursiv zu gestalten. Um den Text Kursiv darzustellen wird vor und nach dem Text ein Stern hinzugefügt. Für die Fettschrift werden vor und nach dem Text zwei Sterne hinzugefügt. Für beide Varianten in Kombination wird die Zeile mit drei Sternen versehen. Hier dürfen vor und nach dem Stern keine Leerzeichen gesetzt werden.

Beispiel:

MarkdownHTMLErgebnisInfo
**CTO**
<b>CTO</b>CTO 
**CLARC**
<b>CLARC</b>CLARC 
***C4***
i><b>C4</i></b>C4 

Zitate

Für die Darstellung von Zitaten wird nach einem Zeilenumbruch an den Anfang jeder Zeile eine schließende spitze Klammer (>) vorangestellt. Innerhalb eines Zitates können auch weitere Markdown-Elemente wie zum Beispiel Kopfzeilen oder Listen dargestellt werden. Zitate werden in einem HTML-Blockquote-Element angezeigt. <blockquote></blockquote>

Beispiel:

MarkdownHTMLErgebnisInfo
> "Testing".

<blockquote> "Testing" </blockquote>

"Testing"

 

Listen

Sortierte Listen werden durchnummeriert dargestellt. Beim Erstellen der Liste kann der Anwender seine Liste beliebig durchnummerieren, dabei spielt die Reihenfolge der Durchnummerierung keine Rolle. Die Ziffern können auch doppelt verwendet werden. Für eine korrekte Darstellung der Listen sollte nach jedem Zeichen mindestens ein Leerzeichen hinzugefügt werden.

Beispiel für eine sortierte Liste:

MarkdownHTMLErgebnisInfo
1. Eintrag
1. Ein anderer Eintrag
1. Ein neuer Eintrag

<ol>

<li>Eintrag</li>

<li>Ein anderer Eintrag</li>

<li>Ein neuer Eintrag</li>

</ol>

  1. Eintrag
  2. Ein anderer Eintrag
  3. Ein neuer Eintrag
 

Unsortierte Listen sind Aufzählungen, die mit einem Stern (*), einem Bindestrich (-) oder einem (+) Zeichen erstellt werden können. Alle drei Zeichen sind erlaubt und werden vor der jeweiligen Zeile hinzugefügt. Um einen Unterpunkt in einer Liste darzustellen wird die jeweilige Zeile mit vier Leerzeichen eingerückt. Zu einer Liste können auch selbstverständlich Zitate oder Quelltext hinzugefügt werden.

Beispiel für eine unsortierte Liste:

MarkdownHTMLErgebnisInfo
*  Erster Eintrag
*  Zweiter Eintrag
    *  Erster Unterpunkt
*  Dritter Eintrag

<ul>

<li>Erster Eintrag</li>

<li>Zweiter Eintrag</li>

<ul><li>Erster Unterpunkt</li>

</ul><li>Dritter Eintrag</li>

</ul>

  • Erster Eintrag
  • Zweiter Eintrag
    • Erster Unterpunkt
  • Dritter Eintrag
 

URL

Die URL wird in einem öffnenden und schließenden Tag in Form eines BB-Codes, welches analog zu HTML ist dargestellt. Dazwischen wird dann als Text die URL eingegeben.

Hinweis

Die Syntax für die URL und Bild-URL entspricht nicht dem Original von Markdown. Hier wurden die Syntax-Regelungen aus Vereinfachungsgrüden angepasst.

Beispiel:

MarkdownHTMLErgebnisInfo
[URL]www.cto.de[/URL]
<a href="http://www.cto.de/"> http://www.cto.de</a>  

Bild-URL

Damit eine Bild-URL mit eingebunden werden kann muss zwischen dem öffnenden und schließenden Tag der Pfad oder der Link eingegeben werden.

Beispiel:

MarkdownHTMLErgebnisInfo
[IMG]/example.gif[/IMG]
<img src="/example.gif" />  

Code

Für formatierte Code-Zeilen wird der entsprechende Quelltext zwischen dem öffnenden und schließenden Tag eingefügt. Für Quelltexte wird ebenfalls die BB-Code Schreibweise verwendet.

Beispiel:

MarkdownHTMLErgebnisInfo
[CODE]Das ist ein Code-Block[/CODE]
<code> Das ist ein Code-Block </code>

Das ist ein Code-Block