Edgewall Software

Version 7 (modified by Steffen Hoffmann, 13 years ago) ( diff )

next edit of cheat sheet and related content: links, Trac Links, setting anchors, escaping markup

basiert auf Version 108 von WikiFormatting, in weiteren Sprachen verfügbar: Russisch

WikiFormatting

Wiki-Formatierung ist eine von Trac's wesentlichen Funktionen, die alle anderen Teile von Trac zu einem anpassungs- und leistungsfähigen Ganzen verbindet.

Trac hat einen schlanken integrierten Wiki-Prozessor. Dieser Wiki-Prozessor stellt eine ständig wachsende Anzahl von Anweisungen anderer bekannter Wikis bereit, insbesondere von MoinMoin und WikiCreole.

Diese Seite stellt die Formatierungssyntax detailliert dar, die überall verfügbar ist, wo Wiki-Formatierung eingesetzt werden kann.

Die folgende Referenzseite gibt einen groben Überblick über die gebräuchlichste Syntax. Jeder Verweis in der Spalte Kategorie führt zu einer ausführlicheren Beschreibung weiter unten auf dieser Seite.

Einige andere Wikiseiten stellen weiterführende Eigenschaften der Wiki-Formatierung von Trac noch genauer dar:

  • TracLinks behandelt alle möglichen Arten, präzise auf jedes Trac-Dokument oder Teile davon zu verweisen,
  • WikiPageNames bespricht die verschiedenen Namen, die Wikiseiten erhalten können, mit oder ohne CamelCase-Form
  • WikiMacros listet die zur Erstellung von dynamischen Inhalten verfügbaren Macros auf,
  • WikiProcessors und WikiHtml präzisieren, wie Teile des Wikitextes auf besondere Art und Weise behandelt werden können

Cheat sheet

Kategorie Wiki-Formatierung Darstellung

Schriftarten

'''fett''', ''kursiv'', '''''Wikipedia-Stil''''' fett, kursiv, Wikipedia-Stil
`einheitlich breit und ''nicht-Wiki''` einheitlich breit und ''nicht-Wiki''
**fett**, //kursiv//, **//!WikiCreole-Stil//** fett, kursiv, WikiCreole-Stil
Überschriften
== 2. Grad ==
=== 3. Grad ^([#hn Hinweis])^

2. Grad

3. Grad (Hinweis)

Absätze
Erster Absatz
auf mehreren Zeilen.

Zweiter Absatz.

Erster Absatz auf mehreren Zeilen.

Zweiter Absatz.

Listen
* Aufzählungsliste
  verteilt über mehrere Zeilen
  1. eingebettete Liste
    a. abweichender Stil
       der Nummerierung
  • Aufzählungsliste verteilt über mehrere Zeilen
    1. eingebettete Liste
      1. abweichender Stil der Nummerierung

Definitionslisten

 Begriff:: mehrzeilige
           Definition
Begriff
mehrzeilige Definition
Vorformatierter Text
{{{
mehrere Zeilen, ''nicht-Wiki''
      berücksichtigt Leerzeichen
}}}
mehrere Zeilen, ''nicht-Wiki''
      berücksichtigt Leerzeichen
Zitat-Block
  bei vorangestellten Leerzeichen
  wird der Text eingerückt

bei vorangestellten Leerzeichen wird der Text eingerückt

Diskussionszitate
>> ... (Ich sagte)
> (er antwortete)

… (Ich sagte)

(er antwortete)

Tabellen
||= Tabellenkopf =|| Zelle ||
||||  (Einzelheiten weiter unten)  ||
Tabellenkopf Zelle
(Einzelheiten weiter unten)

Verweise

http://trac.edgewall.org http://trac.edgewall.org
WikiFormatting (CamelCase) WikiFormatting (CamelCase)

Verweise in Trac («Trac Links»)

wiki:WikiFormatting, wiki:"WikiFormatting" wiki:WikiFormatting, wiki:"WikiFormatting"
#1 (Ticket), [1] (Changeset), {1} (Bericht) #1 (Ticket), [1] (Changeset), {1} (Bericht)
ticket:1, ticket:1#comment:1 ticket:1, ticket:1#comment:1
Ticket [ticket:1], [ticket:1 Ticket eins] Ticket 1, Ticket eins
Ticket [[ticket:1]], [[ticket:1|Ticket eins]] Ticket 1, Ticket eins

Sprungmarken setzen

[=#Punkt1 (1)] Erstens... (1) Erstens…
Siehe [#Punkt1 (1)] Siehe (1)

Formatierung auskommentieren

!'' doppelte Anführungszeichen '' doppelte Anführungszeichen
!wiki:WikiFormatting, !WikiFormatting wiki:WikiFormatting, WikiFormatting
{{{-}}} geschweifte Klammern - geschweifte Klammern
Images [[Image(link)]] trac_logo_mini.png

Macros

[[MacroList(*)]] (short list of all available macros)
[[Image?]] (help for the Image macro)
Processors
{{{
#!div style="font-size: 80%"
Code highlighting:
  {{{#!python
  hello = lambda: "world"
  }}}
}}}

Code highlighting:

hello = lambda: "world"
Comments
{{{#!comment
Note to Editors: ...
}}}
Miscellaneous
Line [[br]] break 
Line \\ break
----

Line
break Line
break


Schriftarten

Das Trac-Wiki erlaubt die folgenden Schriftarten:

Wiki-Formatierung Darstellung
 * '''fett''', 
   ''' drei Anführungszeichen !''' 
   können mit vorangestelltem ! ebenfalls fett dargestellt werden ''', 
 * ''kursiv''
 * '''''fett kursiv''''' oder ''kursiv und
   ''' kursiv fett ''' ''
 * __unterstrichen__
 * {{{gleichmäßig breit}}} oder `gleichmäßig breit`
   (daher `{{{` oder {{{`}}} Auskommentierung)
 * ~~durchgestrichen~~
 * ^hochgestellt^ 
 * ,,tiefgestellt,,
 * **auch fett**, //ebenso kursiv//, 
   und **'' fett kursiv **'' //(seit 0.12)//
  • fett, drei Anführungszeichen ''' können mit vorangestelltem ! ebenfalls fett dargestellt werden ,
  • kursiv
  • fett kursiv oder kursiv und kursiv fett
  • unterstrichen
  • gleichmäßig breit oder gleichmäßig breit (daher {{{ oder ` Auskommentierung)
  • durchgestrichen
  • hochgestellt
  • tiefgestellt
  • auch fett, ebenso kursiv, und fett kursiv (seit 0.12)

Anmerkungen:

  • {{{...}}} und `...` Anweisungen wählen nicht nur eine gleichmäßig breite Schrift, sie behandeln ihren Inhalt auch als Klartext, d.h. dieser Text wird nicht weiter behandelt.
  • ! weist den Wiki-Übersetzer an, die nachfolgenden Zeichen nicht als Wiki-Formatierung auszuwerten. Denken Sie deshalb daran, nach ! ein Leerzeichen zu setzen, z.B. wenn Sie mit Fettschrift enden.
  • Alle Schriftstil-Marken müssen als öffnende/abschließende Paare gesetzt werden, und sie müssen korrekt verschachtelt werden (insbesondere kann ein '' kursiv nicht mit einem // kursiv kombiniert werden, und ''' nicht mit **).

Überschriften

Sie können Überschriften erstellen, indem Sie eine Zeile mit einem bis sechs Gleichheitszeichen beginnen ("="), gefolgt von einem einzelnen Leerzeichen und dem Titelzeilentext.

Dem Titelzeilentext kann die gleiche Anzahl an "="-Zeichen folgen, aber dies ist nicht mehr zwingend erforderlich.

Schließlich kann der Überschrift eine vorgegebene ID folgen. Ohne Vorgabe wird trotzdem eine lesbare ID erzeugt.

Wiki-Formatierung Darstellung
= Hauptüberschrift =
== Überschift 2. Grades
=== Über ''diese Thema'' ===
=== Vorgegebene ID === #Nutzung-vorgegebenen-IDs-in-Überschriften
== Überschift 2. Grades #Überschrift2

Hauptüberschrift

Überschift 2. Grades

Über diese Thema

Vorgegebene ID

Überschift 2. Grades

Absätze

Immer dann, wenn zwei Textblöcke durch eine oder mehrere Leerzeilen getrennt sind, wird ein neuer Textabsatz erzeugt.

Ein erzwungener Zeilenumbruch kann ebenfalls wie folgend eingefügt werden:

Wiki-Formatierung Darstellung
Zeile 1[[BR]]Zeile 2
Absatz
eins

Absatz 
zwei

Zeile 1
Zeile 2

Absatz eins

Absatz zwei

Listen

Das Wiki unterstützt sowohl einfache als auch geordnete/nummerierte Listen.

Beispiel:

Wiki-Formatierung Darstellung
 * Element 1
   * Element 1.1
      * Element 1.1.1   
      * Element 1.1.2
      * Element 1.1.3
   * Element 1.2
 * Element 2
- Elemente können am Anfang einer Zeile beginnen
  und mehrere Zeilen umfassen
  - Achten Sie sorgfältig auf passende Einrückung
  der Fortsetzung in der nächsten Zeile,
weil ansonsten ein neuer Absatz erzeugt wird ...

 1. Element 1
   a. Element 1.a
   a. Element 1.b
      i. Element 1.b.i
      i. Element 1.b.ii
 1. Element 2
Nummerierte Listen können auch
mit einer vorgegebenen Nummer weitergeführt werden:
 3. Element 3
  • Element 1
    • Element 1.1
      • Element 1.1.1
      • Element 1.1.2
      • Element 1.1.3
    • Element 1.2
  • Element 2
  • Elemente können am Anfang einer Zeile beginnen und mehrere Zeilen umfassen
    • Achten Sie sorgfältig auf passende Einrückung der Fortsetzung in der nächsten Zeile,

weil ansonsten ein neuer Absatz erzeugt wird …

  1. Element 1
    1. Element 1.a
    2. Element 1.b
      1. Element 1.b.i
      2. Element 1.b.ii
  2. Element 2

Nummerierte Listen können auch mit einer vorgegebenen Nummer weitergeführt werden:

  1. Element 3

Definitionslisten

Das Wiki erlaubt außerdem Definitionslisten.

Wiki-Formatierung Darstellung
 llama::
   eine Säugetierart, mit Haaren
 ppython::
   eine Reptilienart, ohne Haar
   (Schreibfehler gefunden?)
llama
eine Säugetierart, mit Haaren
ppython
eine Reptilienart, ohne Haar (Schreibfehler gefunden?)

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

Vorformatierter Text

Textböcke mit vorformatiertem Text eignen sich für Teile von Programmcode, Anmerkungen und Beispiele. Setzen Sie den Text in drei geschweifte Klammern, um einen Zitat-Block (engl.: block quote) einzuleiten. Die geschweiften Klammern müssen auf einer eigenen Zeile stehen.

Wiki-Formatierung Darstellung
{{{
def HelloWorld():
    print '''Hello World'''
}}}
def HelloWorld():
    print '''Hello World'''

Beachten Sie, dass diese Art von Textblock auch dazu benutzt wird, Zeilen für die Bearbeitung durch Wiki-Prozessoren auszuwählen.

Zitat-Block

Rücken Sie den Absatz mit zwei Leerzeichen ein, um ihn als Zitat-Block zu markieren.

Wiki-Formatierung Darstellung
Absatz
  Dieser Text ist ein Zitat eines anderen.

Absatz

Dieser Text ist ein Zitat eines anderen.

Diskussionszitate

Um Zitate im Verlauf einer Diskussion, beispielsweise in den Ticketkommentaren, zu kennzeichnen, können Zitatmarken wie bei E-Mails (">", ">>", etc.) eingesetzt werden.

Wiki-Formatierung Darstellung
>> Jemandes ursprünglicher Text
> Antworttext eines anderen
>  - mit jeglicher Art von Wiki-Formatierung
Mein Antworttext

Jemandes ursprünglicher Text

Antworttext eines anderen

  • mit jeglicher Art von Wiki-Formatierung

Mein Antworttext

Tabellen

Einfache Tabellen

Einfache Tabellen können folgendermaßen erstellt werden:

Wiki-Formatierung Darstellung
||Zelle 1||Zelle 2||Zelle 3||
||Zelle 4||Zelle 5||Zelle 6||
Zelle 1Zelle 2Zelle 3
Zelle 4Zelle 5Zelle 6

Zellenüberschriften können durch Setzen des Inhalts zwischen ein Paar Gleichheitszeichen definiert werden. Beachten Sie, dass die '='-Zeichen bündig mit den Zellgrenzenmarken sein müssen, etwa so:

Wiki-Formatierung Darstellung
||        ||= stabil =||= neueste =||
||= 0.10 =||  0.10.5  || 0.10.6dev||
||= 0.11 =||  0.11.6  || 0.11.7dev||
stabil neueste
0.10 0.10.5 0.10.6dev
0.11 0.11.6 0.11.7dev

Schließlich bedeutet die Angabe einer leeren Zelle, dass die nächste nicht-leere Zelle mit auf die leeren Zellen ausgedehnt wird. Zum Beispiel:

Wiki-Formatierung Darstellung
|| 1 || 2 || 3 ||
|||| 1-2 || 3 ||
|| 1 |||| 2-3 ||
|||||| 1-2-3 ||
1 2 3
1-2 3
1 2-3
1-2-3

Beachten Sie, dass der Inhalt einer Zelle an der Seite ausgerichet wird, an der der Inhalt der Zelle anliegt, und nur an dieser. Beispiel:

Wiki-Formatierung Darstellung
||=Text =||= Zahlen =||
||links ausgerichtet   ||      1.0||
||  zentriert          ||      4.5||
||      rechts ausgerichtet||  4.5||
|| Standardausrichtung ||      2.5||
||Standard||         2.5||
||  Standard ||      2.5||
|| Standard ||       2.5||
Text Zahlen
links ausgerichtet 1.0
zentriert 4.5
rechts ausgerichtet 4.5
Standardausrichtung 2.5
Standard 2.5
Standard 2.5
Standard 2.5

Falls die Zellen, im Gegensatz zum vorherigen Beispiel, mehr Text enthalten, könnte es zweckmäßg sein, die Tabellenzeilen auf mehrere Zeilen Wiki-Formatierung zu verteilen. Das \-Zeichen weist Trac am Ende einer Zeile nach einer Zellgrenzenmarke an, die Zellen auf der nächsten Zeile nicht auf eine neue Tabellenzeile zu setzen.

Wiki-Formatierung
|| das ist Spalte 1 [http://trac.edgewall.org/newticket neues Ticket] || \
|| das ist Spalte 2 [http://trac.edgewall.org/roadmap der weitere Weg] || \
|| dies ist Spalte 3, die letzte ||
Darstellung
das ist Spalte 1 neues Ticket das ist Spalte 2 der weitere Weg dies ist Spalte 3, die letzte

Komplex aufgebaute Tabellen

Falls die Möglichkeiten, die mit der zuvor beschriebenen, trennstrich-basierten Formatierung für Tabellen geboten werden, Ihre Anforderungen nicht erfüllen, können Sie aufwendigere Tabellen auf Basis von Wiki-Prozessoren erstellen.

Verweise werden bei Wikiseitennamen und URLs automatisch erzeugt. WikiSeitenVerweise können durch das Voranstellen eines Ausrufezeichens "!" deaktiviert werden, so wie bei !WikiSeitenVerweis.

Wiki-Formatierung Darstellung
TitleIndex, http://www.edgewall.com/, !KeinVerweis

TitleIndex, http://www.edgewall.com/, KeinVerweis

Verweisen kann ein zutreffenderer Titel gegeben werden, indem der Verweis gefolgt von einem Leerzeichen und einem Titel in eckigen Klammern geschrieben wird. Falls man auf diesen Titel verzichtet, wird der Bezeichner entfernt, außer der Verweis ist ein externer Verweis. Dies kann für Wikiseiten nützlich sein, die nicht der Wikiseiten-Namenskonvention folgen.

Wiki-Formatierung Darstellung
 * [http://www.edgewall.com Edgewall Software]
 * [wiki:TitleIndex Inhaltsverzeichnis] 
 * [wiki:TitleIndex] 
 * [wiki:ISO9000]

Dem WikiCreole-Trend folgend kann ein zutreffenderer Titel auch als Verweis gefolgt von einem senkrechten Trennstrich ('|') und dem Titel in doppelten eckigen Klammern geschrieben werden.

 * [[http://www.edgewall.com|Edgewall Software]]
 * [[wiki:TitleIndex|Inhaltsverzeichnis]]
   oder sogar [[TitleIndex|Inhaltsverzeichnis]]
 * [[wiki:TitleIndex]]
   ''' aber nicht ![[TitleIndex]]! '''
 * [[ISO9000]]

Anmerkung: Der WikiCreole-Stil für Verweise ist schnell zu schreiben und wirkt sicherlich vertraut, weil er auch von Wikipedia und vielen anderen Wikis benutzt wird. Leider erzeugt er einen Konflikt mit der Syntax für Makros. Daher rufen Sie in dem seltenen Fall, in dem Sie auf eine Seite verweisen, die nach einem Makro benannt ist (typische Beispiele sind TitleIndex, InterTrac und InterWiki), mit der Schreibweise [[TitleIndex]] das Makro auf, anstatt auf diese Seite zu verweisen.

Wikiseiten können direkt auf andere Teile des Trac-Systems verweisen. Um auf Tickets, Berichte, Changesets, Meilensteine, Dateien mit Programmcode und auf andere Wikiseiten zu verweisen, sind die folgenden Schreibweisen verwendbar:

Wiki-Formatierung Darstellung
 * Tickets: #1 or ticket:1
 * Berichte: {1} or report:1
 * Changesets: r1, [1] or changeset:1
 * ...
 * in Bezug zu anderen Trac-Instanzen, 
   sogenannten InterTrac-Verweisen:
   - Tickets: #Trac1 or Trac:ticket:1
   - Changesets: [Trac1] or Trac:changeset:1

Es noch viele weitere Varianten von Trac-Verweisen. Die Seite über Trac-Verweise enthält ausführlichere Informationen und eine Referenz aller Standard-Verweisübersetzer.

Sprungmarken setzen

Eine Sprungmarke, oder korrekter bezeichnet, ein Sprungmarkenname (engl.) kann an jeder Stelle einer Wikiseite definiert werden, um eine Dokumentenposition eindeutig zu bezeichnen:

[=#Punkt1]

Dies Schreibweise wurde gewählt, um dem Format für die zuvor beschriebene, definierte Benennung der Überschriften-ID zu entsprechen. Zum Beispiel:

== Lange Überschrift == #title

Dies ist auch der Schreibweise für einen Verweis auf diese Sprungmarke sehr ähnlich:

[#Punkt1]

Wahlweise kann die Sprungmarke mit eine Aufschrift versehen werden:

[[=#Punkt1 '''Punkt 1''']]
Wiki-Formatierung Darstellung
[#Punkt2 Springe zum zweiten Punkt]

...

Punkt 2:  [=#Punkt2] Springe hierhin

Springe zum zweiten Punkt

Punkt 2: Springe hierhin

Für aufwendiger gestaltete Sprungmarken (z.B., wenn ein abweichendes title-HTML-Attribut gewünscht wird) kann das Span-Makro genutzt werden, z.B. [[span(id=Punkt2, class=wikianchor, title=Punkt 2, ^(2)^)]].

Formatierung auskommentieren

Sie können die Erzeugung von Verweisen aus Trac-Verweisen vermeiden, indem Sie einem Ausdruck ein einzelnes "!" (Ausrufezeichen) voranstellen.

Wiki-Formatierung Darstellung
 !KeinVerweis
 !#42 ist kein Verweis
 {{{-}}} Minus-Zeichen am Zeilenanfang beginnt keine Liste \\
 {{{1.}}} Zahl am Zeilenanfang beginnt keine Liste \\
 {{{*}}} Stern am Zeilenanfang beginnt keine Liste

KeinVerweis #42 ist kein Verweis

- Minus-Zeichen am Zeilenanfang beginnt keine Liste
1. Zahl am Zeilenanfang beginnt keine Liste
* Stern am Zeilenanfang beginnt keine Liste

Images

Urls ending with .png, .gif or .jpg are no longer automatically interpreted as image links, and converted to <img> tags.

You now have to use the [[Image]] macro. The simplest way to include an image is to upload it as attachment to the current page, and put the filename in a macro call like [[Image(picture.gif)]].

In addition to the current page, it is possible to refer to other resources:

  • [[Image(wiki:WikiFormatting:picture.gif)]] (referring to attachment on another page)
  • [[Image(ticket:1:picture.gif)]] (file attached to a ticket)
  • [[Image(htdocs:picture.gif)]] (referring to a file inside the environment htdocs directory)
  • [[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]] (a file in repository)
Wiki Markup Display
[[Image(htdocs:../common/trac_logo_mini.png)]]

trac_logo_mini.png

See WikiMacros for further documentation on the [[Image()]] macro, which has several useful options (title=, link=, etc.)

Macros

Macros are custom functions to insert dynamic content in a page.

Wiki Markup Display
[[RecentChanges(Trac,3)]]

See WikiMacros for more information, and a list of installed macros.

The detailed help for a specific macro can also be obtained more directly by appending a "?" to the macro name.

Wiki Markup Display
[[MacroList?]]

[[MacroList]]

Display a list of all installed Wiki macros, including documentation if available.

Optionally, the name of a specific macro can be provided as an argument. In that case, only the documentation for that macro will be rendered.

Note that this macro will not be able to display the documentation of macros if the PythonOptimize option is enabled for mod_python!

Processors

Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in reStructuredText or HTML.

Wiki Markup Display

Example 1: HTML

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

HTML Test

Example 2: Code Highlighting

{{{
#!python
class Test:

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

Example 3: Complex Tables

{{{#!th rowspan=4 align=justify
With the `#td` and `#th` processors,
table cells can contain any content:
}}}
|----------------
{{{#!td
  - lists
  - embedded tables
  - simple multiline content
}}}
|----------------
{{{#!td
As processors can be easily nested, 
so can be tables:
  {{{#!th
  Example:
  }}}
  {{{#!td style="background: #eef"
  || must be at the third level now... ||
  }}}
}}}
|----------------
{{{#!td
Even when you don't have complex markup,
this form of table cells can be convenient
to write content on multiple lines.
}}}

With the #td and #th processors, table cells can contain any content:

  • lists
  • embedded tables
  • simple multiline content

As processors can be easily nested, so can be tables:

Example:

must be at the third level now…

Even when you don't have complex markup, this form of table cells can be convenient to write content on multiple lines.

See WikiProcessors for more information.

Comments

Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.

Wiki Markup Display
Nothing to
{{{
#!comment
Your comment for editors here
}}}
see ;-)

Nothing to

see ;-)

Miscellaneous

An horizontal line can be used to separated different parts of your page:

Wiki Markup Display
Four or more dashes will be replaced 
by an horizontal line (<HR>)
----
See?

Four or more dashes will be replaced by an horizontal line (<HR>)


See?

"macro" style [[br]] line break

"macro" style
line break

!WikiCreole style \\ line\\break

WikiCreole style
line
break

Note: See TracWiki for help on using the wiki.