Trac Links

TracLinks sind das fundamentale Feature in Trac, weil damit ganz leicht Hyperlinks zwischen allen Komponenten von Trac geschaffen werden können - beispielsweise zwischen Tickets, Changesets, Wiki-Seiten, Meilensteinen, Quellcode-Dateien - und zwar überall dort, wo WikiFormatting benutzt werden kann.

TracLinks haben die grundsätzliche Form type:id (wobei id die Nummer, den Namen oder einen Pfad des jeweiligen Elements darstellt), für manche häufig benutzten Links existieren auch Abkürzungen.

Beispiele:

  • Tickets: #1 oder ticket:1
  • Ticket Kommentare: comment:ticket:1:2
  • Changesets: r1, [1], changeset:1 oder (eingeschränkt auf den Pfad) [1/trunk], changeset:1/trunk
  • Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3
  • Diffs: diff:@1:3, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default or diff:trunk/trac@3538//sandbox/vc-refactoring@3539
  • Wiki-Seiten: CamelCase or wiki:CamelCase
  • Meilensteine: milestone:"SELFHTML 9.0"
  • Attachments: attachment:ticket:944:attachment.1073.diff
  • Dateien: source:trunk/COPYING
  • Eine bestimme Dateiversion: source:/trunk/COPYING@200
  • Eine Zeile in einer bestimmten Dateiversion: source:/trunk/COPYING@200#L25

Das wird angezeigt als:

Note: Die Form wiki:CamelCase wird selten benutzt, aber kann hilfreich sein zur Verlinkung von Seiten, die nicht den Regeln der WikiPageNames folgen, z.B. einzelne Worte, Sonderzeichen etc. In WikiPageNames steht mehr zur Verlinkung von Wiki-Seiten.

Allen Trac-Links, die die Langform der Verlinkung nutzen, kann außerdem auch ein angepaßter Linktext gegeben werden: 

[ticket:1 Hier ist der Link zu Ticket 1].

Wird angezeigt als: Hier ist der Link zu Ticket 1.

Wenn der Linktitel weggelassen wird, wird nur der ID-Teil des Links (hinter dem Doppelpunkt) angezeigt. 

[ticket:1]

Anzeige: 1

wiki wird standardmäßig angenommen, wenn kein Linktyp angegeben ist: 

[SandBox Der Spielplatz]

Anzeige: Der Spielplatz

TracLinks sind eine sehr einfache Idee, aber erlauben die Errichtung eines komplexen Netzwerkes an Informationen. In der Praxis ist es sehr intuitiv und einfach zu benutzen, und es hilft einem Besucher enorm beim Verständnis und der Erforschung in einem Projekt, z.B. bei der Recherche nach dem Grund für eine bestimmte Änderung.

Die folgenden Abschnitte beschreiben die einzelnen Linktypen detailliert und geben Hinweise zur fortgeschrittenen Linknutzung.

Die Syntax für Links zu Attachments lautet:

  • attachment:the_file.txt erzeugt einen Link zum Attachment the_file.txt des aktuellen Objektes
  • attachment:wiki:MyPage:the_file.txt erzeugt einen Link zum Attachment the_file.txt der Wiki-Seite MyPage
  • attachment:ticket:753:the_file.txt erzeugt einen Link zum Attachment the_file.txt des Tickets 753

Das Standardverhalten eines source:/some/path Links ist, den Verzeichnisbrowser zu öffnen, wenn der Pfad auf ein Verzeichnis zeigt, und andernfalls die Log-Ansicht zu zeigen. Es ist auch möglich, direkt zu einer bestimmten Revision einer Datei zu linken: source:/some/file@123 oder so wie hier zur aktuellsten Version der Datei: source:/some/file@latest. Wenn die Version angegeben ist, kann auch direkt zu einer bestimmten Zeile verlinkt werden: source:/some/file@123#L10

Siehe TracSearch#SearchLinks and TracQuery#UsingTracLinks

Um einen SubWiki? Link zu einer SubWiki?-Seite zu erstellen, muss nur ein '/' benutzt werden: 

 [wiki:WikiPage/SubWikiPage].

Andere Linktypen können frei definiert werden und auf bestimmte externe Ressourcen in anderen Webapplikationen verweisen. Die Definition dieser Typen sowie der damit verbundenen URL wird in einer speziellen Wiki-Seite festgelegt (InterMapTxt). Obwohl diese Methode auch dazu genutzt werden kann, Links zu anderen Trac-Installationen zu erstellen, gibt es dafür eine speziellere Methode, die mehr Flexibilität bietet.

Jede Form der Trac-Links kann sowohl auf Ziele im lokalen Trac, als auch auf ein beliebiges externes Trac zeigen, solange der passende Präfix dieses externen Tracs angegeben wird. Details dazu in InterTrac.

Es ist häufig sinnvoll, nur relativ auf andere Objekte auf dem Server zu verlinken, für die kein Trac-Linktyp existiert, beispielsweise statische Ressources, eine Registrierseite etc. Dies wird erreicht, indem einfach der absolute oder relative Pfad ohne Serverangabe benutzt wird: 

[../newticket New Ticket]
[/ Startseite]

Display: New Ticket Startseite

Alle Linkziele, deren ID ihrerseits Leerzeichen enthält, müssen in einfache oder doppelte Anführungszeichen eingeschlossen werden. Beispiele:

  • wiki:"Die Leerzeichen-Konvention"
  • attachment:'the file.txt' oder
  • attachment:"the file.txt"
  • attachment:"ticket:123:the file.txt"

Wo TracLinks überall benutzt werden können

TracLinks funktionieren in:

  • Source code (Subversion) commit messages
  • Wiki-Seiten
  • Allen Beschreibungen von Tickets und Meilensteinen

und in allen anderen Textfeldern, bei denen explizit notiert ist, dass sie WikiFormatting unterstützen.

Um zu verhindern, dass ein TracLink als Link angesehen wird, kann er mit einem vorangestellten Ausrufezeichen escaped werden. 

 !NoLinkHere.
 ![42] ist auch kein Link.

Display:

NoLinkHere. [42] ist auch kein Link.

Verweise zu verwandten Themen: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki

Ü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.