WikiFormatting

Das Wiki-Markup in Trac ist ein zentrales Feature, welches alle anderen Teile von Trac zu einem flexiblen und mächtigen Ganzen verbindet.

Trac enthält eine kleine, mächtige Wiki-Engine, die eine ständig wachsende Zahl von Formatierungsmöglichkeiten enthält, die sich an den Kommandos bekannter Wikis orientieren, allen voran MoinMoin.

Diese Seite demonstriert die Formatierungs-Syntax, die überall dort eingesetzt werden kann, wo WikiFormatting erlaubt ist.

Font Styles

Das Trac wiki unterstützt die folgenden Schriftstile:

 * '''fett''', '''!''' kann auch fett sein''', und '''! '''
 * ''kursiv''
 * '''''fett-kursiv'''''
 * __unterstrichen__
 * {{{Monospace}}} oder `Monospace`
 * ~~durchgestrichen~~
 * ^hochgestellt^ 
 * ,,tiefgestellt,,

Anzeige als:

• fett, ''' kann auch fett sein, und !
• kursiv
• fett-kursiv
• unterstrichen
• Monospace oder Monospace
• durchgestrichen
• ^hochgestellt
• _tiefgestellt

Anmerkung:

• {{{...}}} und `...` wählen nicht nur einfach die Monospace-Schriftart, sondern verhindern auch, dass darin enthaltene Wiki-Formatierungen ausgeführt werden.
• ! weist den Wiki-Parser an, die darauf folgenden Zeichen nicht als Wiki-Formatierung anzusehen. Fügen Sie ein Leerzeichen hinter das Ausrufezeichen, wenn Sie z.B. Fettschrift beenden wollen.

Überschriften

Sie können Überschriften erzeugen, indem Sie ein bis fünf Gleichheitszeichen und ein Leerzeichen an den Zeilenanfang schreiben, danach die Überschrift, und die Zeile mit Leerzeichen und der gleichen Zahl an Gleichheitszeichen beenden.

Der Überschrift kann optional noch eine explizit definierte ID folgen, mit der man sie in Links direkt anspringen kann. Wenn keine ID angegeben wird, wird automatisch eine ID aus dem Inhalt der Überschrift generiert.

Beispiel:

= Überschrift H1 =
== Überschrift H2 ==
=== Überschrift H3 mit ''Formatierung'' ===
=== Überschrift mit definierter ID === #using-explicit-id-in-heading

Anzeige:

Überschrift H1

Überschrift H2

Überschrift H3 mit Formatierung

Überschrift mit definierter ID

Absätze

Ein Absatz wird automatisch erzeugt, wenn zwei Textblöcke von einer oder mehr leeren Zeilen getrennt sind.

Ein erzwungener Zeilenumbruch kann eingefügt werden mit:

Zeile 1[[BR]]Zeile 2

Anzeige:

Zeile 1
Zeile 2

Listen

Das Wiki unterstützt sowohl OL als auch UL-Listen.

Beispiel:

 * Punkt 1
   * Punkt 1.1
 * Punkt 2

 1. Punkt 1
   a. Punkt 1.a
   a. Punkt 1.b
      i. Punkt 1.b.i
      i. Punkt 1.b.ii
 1. Punkt 2
Numerierten Listen kann auch explizit eine Numerierung gegeben werden:
 3. Punkt 3

Anzeige:

• Punkt 1
  • Punkt 1.1
• Punkt 2

1. Punkt 1
   1. Punkt 1.a
   2. Punkt 1.b
      1. Punkt 1.b.i
      2. Punkt 1.b.ii
2. Punkt 2

Numerierten Listen kann auch explizit eine Numerierung gegeben werden:

3. Punkt 3

Beachten Sie, dass die Listenzeilen mindestens ein Leerzeichen am Zeilenanfang benötigen. Andernfalls würde der Text als normaler Textabsatz behandelt werden.

Definitionslisten

Das Wiki unterstützt Definitionslisten.

Beispiel:

 SELFHTML::
   bekannte Dokumentation von HTML und verwandten Webtechniken
 SELFHTML aktuell::
   Portal zum gesamten SELHTML-Angebot
   Darunter auch das Weblog

Anzeige:

SELFHTML

bekannte Dokumentation von HTML und verwandten Webtechniken

SELFHTML aktuell

Portal zum gesamten SELHTML-Angebot Darunter auch das Weblog

Beachten Sie, dass ein Leerzeichen vor dem zu definierenden Ausdruck erforderlich ist.

Vorformatierter Text

Vorformatierter Text ist beispielsweise Quellcode, Notizen und Beispiele. Benutzen Sie drei geschweifte Klammern um den Textblock. Die Klammern müssen in einer einen Zeile stehen. Beispiel:

 {{{
  def HelloWorld():
      print "Hello World"
 }}}

Anzeige:

 def HelloWorld():
     print "Hello World"

Blockquotes

Um einen Textabsatz als Blockquote zu markieren, muß er lediglich mit zwei Leerzeichen eingerückt werden.

Beispiel:

  Dieser Text ist ein Zitat von jemand anderem.

Anzeige:

Dieser Text ist ein Zitat von jemand anderem.

Diskussionszitate

Um Zitate in einer Diskussion auseinanderhalten zu können, beispielsweise in einem Ticket, werden Zitatzeichen wie in EMails (">", ">>". etc.) verwendet.

Beispiel:

>> Zitat aus erstem Posting 
> Zitat der Antwort darauf
Meine eigene Antwort

Anzeige:

Zitat aus erstem Posting

Zitat der Antwort darauf

Meine eigene Antwort

Beachten Sie, dass einige WikiFormatting Elemente, beispielsweise Listen und vorformatierter Text, in einem Zitatbereich verloren gehen. Sie müssen wahrscheinlich Umformatierungen vornehmen, um in so einem Fall die Zuordnung klarzustellen.

Tabellen

Einfache Tabellen werden so hergestellt:

||Zelle 1||Zelle 2||Zelle 3||
||Zelle 4||Zelle 5||Zelle 6||

Anzeige:

Zelle 1	Zelle 2	Zelle 3
Zelle 4	Zelle 5	Zelle 6

Es gibt die Möglichkeit, komplexere Tabellen zu erstellen, indem reStructuredText verwendet wird.

Links

Hyperlinks werden automatisch erstellt für WikiPageNames und URLs. WikiPageLinks können verhindert werden, indem ein Ausrufezeichen vorangestellt wird, beispielsweise so: !WikiPageLink.

Beispiel:

 TitleIndex, http://www.selfhtml.org/, !IstKeinLink

Anzeige:

TitleIndex, http://www.selfhtml.org/, IstKeinLink

Links können mit einem beschreibenderen Linktext versehen werden, indem der gesamte Link in eckigen Klammern eingefaßt wird, und der anzuzeigende Linktext, getrennt durch ein Leerzeichen, einfach nach dem Linkziel folgt. Wenn der beschreibende Linktext weggelassen wird, dann wird der Linkpräfix entfernt, wenn kein externes Link verlinkt wird. Das kann nützlich sein, um Seiten im Wiki zu verlinken, die nicht der WikiPageNames Konvention folgen.

Beispiel:

 * [http://www.selfhtml.org/ SELFHTML Projektstartseite]
 * [wiki:TitleIndex Title Index]
 * [wiki:ISO9000]

Display:

• SELFHTML Projektstartseite
• Title Index
• ISO9000?

Trac Links

Wikiseiten können direkt zu anderen Teilen von Trac verlinken. Mögliche Linkziele sind Tickets, Suchergebnisse, Changesets, Meilensteine, Quellcode und andere Wiki-Seiten, die man mit den folgenden Notationen erreicht:

 * Tickets: #1 or ticket:1
 * Reports: {1} or report:1
 * Changesets: r1, [1] or changeset:1
 * ...

Anzeige:

• Tickets: #1 or ticket:1
• Reports: {1} or report:1
• Changesets: r1, [1] or changeset:1
• ...

Details zu diesen Links stehen in TracLinks.

Links und WikiPageNames escapen

Die Verlinkung eines Textes kann verhindert werden, indem ein Ausrufezeichen "!" vorangestellt wird.

Beispiel:

 !NoHyperLink
 !#42 is not a link

Anzeige:

NoHyperLink #42 is not a link

Bilder

Urls, die mit .png, .gif or .jpg enden, werden nicht automatisch in <img>-Tags umgewandelt. Benutzen Sie das [[Image]] macro.

Macros

Macros sind angepaßte Funktionen, um dynamischen Inhalt in eine Seite einzufügen.

Beispiel:

 [[Timestamp]]

Anzeige:

Sun Mar 7 02:23:08 2010

Auf der Seite WikiMacros sind mehr Informationen und eine Liste der installierten Macros enthalten.

Processors

Trac unterstützt alternative Markup-Formate durch WikiProcessors. Beispielsweise können Wiki-Seiten auch mit reStructuredText oder HTML geschrieben werden.

Beispiel 1:

{{{
#!html
<h1 style="text-align: right; color: blue">HTML Test</h1>
}}}

Anzeige:

HTML Test

Beispiel 2:

{{{
#!python
class Test:

    def __init__(self):
        print "Hello World"
if __name__ == '__main__':
   Test()
}}}

Anzeige:

class Test:
    def __init__(self):
        print "Hello World"
if __name__ == '__main__':
   Test()

Perl:

my ($test) = 0;
if ($test > 0) {
    print "hello";
}

Mehr Informationen stehen in WikiProcessors.

Verschiedenes

Vier oder mehr Minuszeichen werden in eine horizontale Trennlinie (<hr>) umgewandelt.

Beispiel:

 ----

Anzeige:

---

---

Verweise zu verwandten Themen: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring?.

---

Übersetzt von Sven Rautenberg, SELFHTML e.V.

Diese deutsche Übersetzung der Original-Trac-Wikiseite ist lizensierbar unter Creative Commons BY-SA: Namensnennung, Weitergabe unter gleichen Bedingungen.