Wer gern und viel mit der Wiki von Redmine arbeitet will irgendwann den Bereich nicht mehr verlassen weil er die Wiki lieben gelernt hat. Das Tolle an einer Wiki ist nicht nur die Möglichkeit an zentraler Stelle gemeinsam Inhalte zu hinterlegen. Sondern dass man neben statischen Inhalten dort auch dynamische Informationen mit Hilfe von Wiki Makros integrieren kann. Makros sind überaus nützlich wenn man die Möglichkeiten eines Wikisystems erweitern will. Deswegen stellen wir euch heute das neue Redmine Wiki Makro des Redmine Additionals Plugins zur Implementierung von Ticketkommentaren kurz vor.
Mit Makros die Redmine Projektwiki aufwerten
Das neuste Update des Additionals Plugin liefert unter anderem eine Erweiterung des Issue-Makro zur Einbindung von Ticketkommentaren in Wikiseiten. Mit dem kann man aus der Redmine Wiki heraus nicht nur auf Tickets oder den Kommentar verlinken, sondern diesen sogar direkt in der Wikiseite anzeigen lassen. Eine überaus hilfreiche Funktion wenn man beispielsweise mit Hilfe der Wiki Protokolle führt und nicht den Text, der schon woanders steht erneut abtippen mag.
Wer dass Issue-Makro für Kommentare einsetzen will, muss lediglich die neuste Plugin-Version installieren. Das Makro funktioniert dann direkt im Anschluss im gewünschten Wikibereich.
Makro Optionen
Das Plugin ist installiert und konfiguriert? Dann kanns auch schon los gehen. Auch bei diesem Makro sind die Parameter relaltiv simpel.
{{issue(url [, format=FORMAT, id=ISSUE_ID, note_id=COMMENT_ID])}}
Verfügbare Parameter
- url (string) – URL zum Ticket mit der Ticket-ID (ohne note_id des Kommentars)
- format (string) – Angabe des Formats zur Ausgabe. Mögliche Werte sind: full, text, short oder link (Standard, wenn nichts anderes angegeben).
- id (int) – issue id (wird dieser Parameter verwendet hat er höhere Priorität als die URL-Angabe)
- note_id (int) – comment id (wird dieser Parameter verwendet hat er höhere Priorität als die URL-Angabe)
Beispiele zur einfachen Ticketverlinkung
Die einfachste Art zur Integration ist einfach die Issue-ID (in unserem Beispiel die 1) einzutragen. Dadurch verlinkt man lediglich auf das Ticket mit der entsprechenden Nummer:
{{issue(1)}}
Da es immer wieder Anwender gibt, die auch mittels “Copy&Paste” auf ein Ticket verlinken ist es möglich das Makro anstelle der ID auch mit der URL zum Ticket zu verwenden. Das sieht so aus und funktioniert natürlich dann auch:
{{issue(http://myredmine.url/issues/1)}}
So. Und einen Link zu einem Ticketkommentar implementiert ihr folgendermaßen. In unserem Beispiel einfach mit der heraus kopierten URL zum Kommentar 3 des Tickets Nummer 1:
{{issue(http://myredmine.url/issues/1#note-3)}}
Beispiel zur Ausgabe eines Ticketkommentars
Nachdem ihr mit den obigen Beispielen gesehen habt wie einfach man das Makro anwenden kann hier ein Beispiel mit dem ihr neben dem Link zum Ticket auch einen Ticketkommentar implementiert. Das funktioniert wie folgt:
{{issue(format=full, id=1, note_id=1)}}
Ihr gebt einfach das Ausgabeformat des Ticketlinks an, die zu verlinkende Ticket-ID (hier ist es das Ticket 1) und dann den Kommentar, dessen Inhalt in der Wiki ausgegeben wird. Fertig.
Was Du mit dem Redmine Ticketmakro machen kannst
Wenn du es verwendest kannst Du:
- auf ein Ticket verlinken
- auf einen Ticketkommentar verlinken
- eine Ticketbezeichnung lediglich als Text in der Wiki ausgeben
- auf ein Ticket verlinken und den Inhalt des dazugehörigen Ticketkommentars in der Wiki ausgeben.
- eine Ticketbezeichnung, sowie den dazugehörigen Ticketkommentar als Text in der Wiki ausgeben.
Was passiert wenn Du auf ein Ticket oder einen Ticketkommentar verlinkst, den es nicht (mehr) gibt? Oder auf dessen Inhalt Du als Anwender keinen Zugriff hast? In dem Fall wird in der Wiki N/A an der Stelle des Makros ausgegeben. Probiert es einfach mal aus.
Redmine Additionals Plugin
Redmine ist ein quelloffenes Projekt- und Aufgabenmanagement Tool das sich mit Hilfe von Plugins um zahlreiche Funktionen erweitern lässt. Das Redmine Additionals Plugin ist eine kostenlose Funktionserweiterung für Redmine. Es bietet zahlreiche Möglichkeiten seine Redmine Installation etwas benutzerfreundlicher zu gestalten und auch ohne Entwicklerkenntnisse kleine Anpassungen durchzuführen. Es stellt euch auch zahlreiche Makros für Wiki und Tickets bereit, die in herkömmlichen Projekten unverzichtbar sind. Eine vollständige Dokumentation der Funktionen ist in Englisch verfügbar. Das multilinguale Plugin kann auf Github herunter geladen werden. Das hier vorgestellte Makro ist ein Feature der neu verfügbaren Additionals Version v2.0.5.