Macros¶
These wiki macros are available with Additionals.
If a parameter is in brackets, this parameter is optional.
Asciinema¶
Graphical application developers often use screencasts to demonstrate functions of their programs. With Asciinema you have the possibility to record such videos, but are restricted completely to the terminal. So you can record and publish actions in the shell. With the additionals plugin macro for Asciinema you can implement such videos into Redmine.
asciinema.org wiki macro for Redmine.
-
{{asciinema(cast_id)}} show asciinema.org cast
Parameters: cast_id (string) – asciinema.org asciicast id
Scope¶
This macro works in all text fields with formatting support.
CryptoCompare¶
CryptoCompare is an Internet plattform where you can interactively inform yourself about the latest trends in crypto currencies and follow the development of the crypto market in real-time.
CryptoCompare wiki macro for Redmine.
See https://www.cryptocompare.com/dev/widget/wizard/ for more information.
-
{{cryptocompare(options)}} show CryptoCompare information
Parameters: - fsym (string) – default BTC
- tsym (string) – default EUR
- fsyms (string) – default BTC,ETH,LTC (if supported by widget type)
- tsyms (string) – default EUR,USD (if supported by widget type)
- period (string) –
(if supported by widget type)
- 1D = 1 day (default)
- 1W = 1 week
- 2W = 2 weeks
- 1M = 1 month
- 3M = 3 months
- 6M = 6 months
- 1Y = 1 year
- type (string) –
widget type has to be one of
- advanced
- chart (default)
- converter
- header
- header_v2
- header_v3
- historical
- list
- news
- summary
- tabbed
- titles
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Show header_v3 widget type for crypto currencies BTC and ETH
{{cryptocompare(fsyms=BTC;ETH, type=header_v3)}}
Date¶
-
{{date([TYPE])}} Display current date
Parameters: TYPE (string) – current_date (default) current date current_date_with_time current date with time current_year current year current_month current month current_day current day current_hour current hour current_minute current minute current_weekday current weekday current_weeknumber current week number (1 - 52) The week starts with Monday YYYY-MM-DD e.g. 2018-12-24, which will formated with Redmine date format
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Show current date.
{{date}}
Show current date with time
{{date(current_date_with_time)}}
Show current year
{{date(current_year)}}
Show current week number
{{date(current_weeknumber)}}
Show date 2018-12-24 in right format, which is specified in Redmine Settings, which shows e.g. 24.12.2018
{{date(2018-12-24)}}
Font Awesome¶
Font Awesome wiki macro for Redmine.
-
{{fa(icon [, class=CLASS, title=TITLE, text=TEXT, link=LINK, color=COLOR])}} Displays a Font Awesome icon
Parameters: - icon (string) – font awesome icon name, e.g. adjust or fas_adjust
- class (string) – additional css classes
- title (string) – mouseover title
- text (string) – text, which is displayed after font awesome icon
- link (string) – link to this url
- color (string) – css color code
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Show font awesome icon “fas fa-adjust”
{{fa(adjust)}}
Show font awesome icon “fas fa-stack” and inverse
{{fa(adjust, class=fa-inverse)}}
Show font awesome icon “fas fa-adjust” with size 4x
{{fa(adjust, size=4x)}}
Show font awesome icon “fas fa-adjust” with title “Show icon”
{{fa(fas_adjust, title=Show icon)}}
Show font awesome icon “fab fa-angellist”
{{fa(fab_angellist)}}
Show font awesome icon “fas fa-adjust” and link it to https://www.redmine.org
{{fa(adjust, link=https=//www.redmine.org))}}
Show font awesome icon “fas fa-adjust” with name “Go to Redmine.org” and link it to https://www.redmine.org
{{fa(adjust, link=https=//www.redmine.de, name=Go to Redmine.org))}}
Icons¶
There are currently more than 1300 free Font Awesome Icons available for implementation. The full list can be found at: https://fontawesome.com/icons?d=gallery&m=free
Note
All you have to do is use the icon name and implement it into your macro as mentioned above.
Gist¶
GitHub, a service for hosting larger projects, also operates other services like Gist. Gist is for hosting code snippets. If you are using the additionals plugin for your Redmine, you can implement your Github Gist by using the following wiki macro.
-
{{gist(gist)}} show Github gist
Parameters: gist (string) – gist to display. With or without Github username.
Scope¶
This macro works in all text fields with formatting support.
Examples¶
show Github gist 6737338 (without user name)
{{gist(6737338)}}
Show Github gist plentz/6737338 (with user name)
{{gist(plentz/6737338)}}
Google Map¶
Google map wiki macro for Redmine to implement a street map. There are various configuration options for presenting the GMap.
-
{{gmap([q=QUERY, mode=MODE, width=WIDTH, height=HEIGHT])}} Show Google map
Parameters: - q (string) – query, e.g. a city or location
- mode (string) – place, directions, search, view oder streetview (default: search)
- width (int) – widget width
- height (int) – widget height
Scope¶
This macro works in all text fields with formatting support.
Examples¶
The simplest way is to show a widget for Munich with Munich
{{gmap(Munich)}}
Another option is to show a widget for direction for example from Munich to Arco (Italy)
{{gmap(mode=directions, origin=Munich+Implerstr, destination=Arco)}}
Google Docs¶
Google Docs wiki macro for Redmine. Google Docs is an online word processor that you can use to create, format, and collaborate on documents. The macro helps you to integrat a Google Docs document as iframe into a Redmine text field.
-
{{google_docs(link[, width=WIDTH, height=HEIGHT, edit_link=URL])}} Show Google Docs embedded
Parameters: - link (string) – Embedded Google docs link
- width (int) – width (if not specified, 100% is used)
- height (int) – height (if not specified, 485 is used)
- edit_link (int) – Link to edit page
Scope¶
This macro works in all text fields with formatting support (e.g. Redmine Wiki).
Examples¶
Google docs https://docs.google.com/spreadsheets/d/e/2PACX-1vQL__Vgu0Y0f-P__GJ9kpUmQ0S-HG56ni_b-x4WpWxzGIGXh3X6A587SeqvJDpH42rDmWVZoUN07VGE/pubhtml (iframe) and default size 100% x 485
{{google_docs(https://docs.google.com/spreadsheets/d/e/2PACX-1vQL__Vgu0Y0f-P__GJ9kpUmQ0S-HG56ni_b-x4WpWxzGIGXh3X6A587SeqvJDpH42rDmWVZoUN07VGE/pubhtml)}}
Google docs with size 1200 x 1000
{{slideshare(https://docs.google.com/spreadsheets/d/e/2PACX-1vQL__Vgu0Y0f-P__GJ9kpUmQ0S-HG56ni_b-x4WpWxzGIGXh3X6A587SeqvJDpH42rDmWVZoUN07VGE/pubhtml, width=1200, height=1000)}}
Members, Group¶
Group users macro for Redmine.
-
{{group_users(group_name)}} Show list of users in a user group (according the respective permissions)
Parameters: group_name (string) – group name
Scope¶
This macro works in all text fields with formatting support.
Iframe¶
Iframe macro for Redmine. The iframe is a square HTML element. It can be embedded e.g. within a Wiki page of Redmine. Via an iframe, content from other Internet pages can be integrated just like via a small integrated browser window.
For example you can integrate a CodiMD Pad page into your Wiki pages.
-
{{iframe(url [, width=INT, height=INT, with_link=BOOL])}} Include an Iframe into Redmine. If your Redmine is running with HTTPS, only iframes with HTTPS are accepted by this macro.
Parameters: - url (string) – URL to website
- width (int) – width (default is 100%)
- height (int) – height (default is 485)
- with_link (bool) – true or false (if link to url should be displayed below iframe)
Note 1: you can only include an iframe, if the website of the iframe url does allow it. If not, you will get a empty page with the HTTP header info:
Load denied by X-Frame-Options: https://your-target-url.com/ does not permit cross-origin framing.Note 2: Your Redmine webserver can also block your iframe inclusion, check your Content Security Policy (CSP)
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Show iframe of URL https://www.google.com/
{{iframe(https://www.google.com/)}}
Show iframe of URL https://www.google.com/ and show link to it
{{iframe(https://www.google.com/, with_link: true)}}
Issue¶
Issue wiki macro for Redmine.
-
{{issue(url [, format=FORMAT, id=ISSUE_ID, note_id=COMMENT_ID])}} Display a link to issue with subject (optional with an issue note)
Parameters: - url (string) – URL to an issue with issue id (and note_id)
- format (string) – custom format of link name. Possible values: full, text, short or link. If not specified ‘link’ is used as default.
- id (int) – issue id (if this is defined, it will be always used prioritized - before the parameter for URL)
- note_id (int) – comment id (if this is defined, it will be always used prioritized - before the parameter for URL)
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Link to issue with id and subject
{{issue(1)}}
Link to issue with id and subject by using the URL
{{issue(http://myredmine.url/issues/1)}}
Link to issue with id and subject and show comment 3
{{issue(http://myredmine.url/issues/1#note-3)}}
Link to issue with subject (without id)
{{issue(1, format=short)}}
Link to issue with tracker, subject and id
{{issue(1, format=full)}}
Display subject of issue
{{issue(1, format=text)}}
Last updated at¶
Last updated at wiki macro for Redmine.
-
{{last_updated_at}} show the timestamp when the wiki page was updated
Scope¶
This macro only works in wiki page contexts.
Last updated by¶
Last updated by wiki macro for Redmine.
-
{{last_updated_by}} show the name of user who updated the wiki page
Scope¶
This macro only works in wiki page contexts.
Meteoblue¶
Meteoblue wiki macro for Redmine. A macro to show weather forecast for a specific place. There are various configuration options for presenting the weather widget.
-
{{meteoblue(location [, days=DAYS, width=WIDTH, height=HEIGHT, color=BOOL, flags...])}} Show weather widget from Meteoblue
Parameters: - location (string) – Weather location, e.g. münchen_deutschland_2867714. This is the part after https://www.meteoblue.com/en/weather/forecast/week/
- width (int) – widget width
- height (int) – widget height
- color (bool) – color or monochrome
- pictoicon (bool) – pictoicon
- maxtemperature (bool) – maxtemperature
- mintemperature (bool) – mintemperature
- windspeed (bool) – windspeed
- windgust (bool) – windgust
- winddirection (bool) – winddirection
- uv (bool) – uv
- humidity (bool) – humidity
- precipitation (bool) – precipitation
- precipitationprobability (bool) – precipitationprobability
- spot (bool) – spot
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Show widget for Munich with münchen_deutschland_2867714 (iframe)
{{meteoblue(münchen_deutschland_2867714)}}
Show widget for Munich with münchen_deutschland_2867714 (iframe) and uv information
{{meteoblue(münchen_deutschland_2867714, uv=true)}}
Members, Project¶
Project members macro for Redmine.
-
{{members([project_name, title=TITLE, role=ROLE, with_sum=BOOL])}} Show list of project members
Parameters: - project_name (string) – can be project identifier, project name or project id
- title (string) – title to use for member list
- role (string) – only list members with this role. If you want to use multiple roles as filters, you have to use a | as separator.
- with_sum (bool) – show amount of members.
Scope¶
This macro works in all text fields with formatting support.
Examples¶
List all members for all projects (with the current user permission)
{{members}}
List all members for all projects and show amount of members
{{members(with_sum=true)}}
List all members for the project with the identifier of myproject
{{members(myproject)}}
List all members for the project with the identifier of myproject, which
have the role Manager
{{members(myproject, role=Manager)}}
List all members for the project with the identifier of myproject, which
have the role Manager or Team
{{members(myproject, role=Manager|Team)}}
- List all members for the project with name
My project titleand with - box title
My member list
{{members(My project title, title=My member list)}}
New issue¶
Create a link for “New issue” for the current user.
-
{{new_issue([project_name, name=NAME])}} Show link to create new issue
Parameters: - project_name (string) – can be project identifier, project name or project id If no project_name is specified, first project is used, which the current user has permission to create an issue.
- name (string) – name to use for link. If not specified, “New issue” is used. You can use all language as suffix, eg. name_de, name_it, button_es
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Link to create new issue in first available project
{{new_issue}}
Link to create new issue in project with the identifier of myproject
{{new_issue(myproject)}}
Link to create new issue in project with the identifier of myproject and
with displayed link name New issue for broken displays
{{new_issue(myproject, title=New issue for broken displays)}}
Link to create new issue in first available project and overwrite name of link only for German users
{{new_issue(name_de: Ticket hier bitte anlegen)}}
Projects¶
Projects wiki macro for Redmine.
-
{{projects([title=TITLE, with_create_issue=BOOL])}} Lists projects of the current user
Parameters: - title (string) – title to use for project list
- with_create_issue (bool) – show link to create new issue, if true
Scope¶
This macro works in all text fields with formatting support.
Examples¶
List all projects of the current users
{{projects}}
List all projects of the current users and adds the heading My project list
{{projects(title=My project list)}}
List all project with link to create new issue, which I am member of
{{projects(with_create_issue=true)}}
Recently updated¶
Recently updated wiki macro for Redmine.
-
{{recently_updated([days])}} show the list of the pages that were changed recently.
Parameters: days (int) – number of days, which should be used. Default is 5.
Scope¶
This macro only works in wiki page contexts.
Examples¶
List last updated pages (of the last 5 days)
{{recently_updated}}
List last updated pages of the last 15 days
{{recently_updated(15)}}
Reddit¶
Reddit is an English-language website for social media news, web content rating and discussions. As a registered member, you can submit content, links or images and present them to other members. Link to your Reddit account or other content within Redmine by using the additionals plugin macro.
Reddit wiki macro for Redmine.
-
{{reddit(name)}} show link to Reddit
Parameters: name (string) – Reddit subject or user name
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Show link to reddit subject r/redmine
{{reddit(redmine)}}
or
{{reddit(r/redmine)}}
Show link to reddit user profile u/redmine
{{reddit(u/redmine)}}
Redmine.org Issue¶
Redmine.org issue wiki macro for Redmine.
-
{{redmine_issue(url [, title=TITLE])}} Display a link to an issue on redmine.org
Parameters: - url (string) – this can be an absolute path to an redmine.org issue or an issue id
- title (string) – title of link to display
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Link to redmine.org issue with issue id
{{redmine_issue(1333)}}
Link to redmine.org issue with issue id and anchor
{{redmine_issue(1333#note-6)}}
Link to redmine.org issue with absolute url
{{redmine_issue(http://www.redmine.org/issues/12066)}}
Redmine.org Wiki page¶
Redmine.org wiki page macro for Redmine.
-
{{redmine_wiki(url [, name=NAME, title=TITLE])}} Display a link to an issue on redmine.org
Parameters: - url (string) – this can be an absolute path to an redmine.org issue or an issue id
- name (string) – name to display for link, if not specified, wiki page name is used
- title (string) – title of link to display
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Link to redmine.org wiki page with page name
{{redmine_wiki(RedmineInstall)}}
Link to redmine.org wiki page with page name and anchor
{{redmine_wiki(FAQ#How-do-I-create-sub-pages-parentchild-relationships-in-the-wiki)}}
Link to redmine.org wiki page with absolute url
{{redmine_wiki(https://www.redmine.org/projects/redmine/wiki/RedmineInstall)}}
TradingView¶
TradingView wiki macro for Redmine.
See https://www.tradingview.com/widget/ for more information.
-
{{tradingview(options)}} show TradingView chart
Parameters: - width (int) – default 640
- height (int) – default 480
- symbol (string) – default NASDAQ:AAPL
- interval (string) – default W
- timezone (string) – default Europe/Berlin
- theme (string) – default White
- style (int) – default 2
- locale (string) – default de
- toolbar_bg (string) – default #f1f3f6
- enable_publishing (bool) – default false
- allow_symbol_change (bool) – default true
- hideideasbutton (bool) – default true
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Show chart with symbol NASDAQ:AMZN and use English locale
{{tradingview(symbol=NASDAQ:AMZN, locale=en)}}
Twitter¶
Twitter wiki macro for Redmine.
-
{{twitter(profile)}} show link to Twitter profile
Parameters: profile (string) – Twitter profile name with @. E.g. alphanodes
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Show link to twitter profile @alphanodes
{{twitter(alphanodes)}}
or
{{twitter(@alphanodes)}}
Show link to hashtag #redmine
{{twitter(#redmine)}}
User¶
User wiki macro for Redmine.
-
{{user(user [, format=FORMAT, text=BOOL, avatar=BOOL])}} Display link to user profile
Parameters: - user (string) – user name (login name) or user id of the user. If current user is used as login name the currently logged in user will be used.
- format (string) – custom format of link name. If not specified system settings will be used. You can use format with the same options as for system settings.
- text (bool) – show text only (without link), if true (default: false)
- avatar (bool) – show avatar, if true (default: false)
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Link to user profile with id 1
{{user(1)}}
Link to user profile with id 1 and show user avatar
{{user(1, avatar=true)}}
Link to user profile with login name admin and show user avatar
{{user(admin, avatar=true)}}
Link to user profile with login name admin with username as link text
{{user(admin, format=username)}}
Link to user profile with login name admin with first name as link text
{{user(admin, format=firstname)}}
Link to user profile with login name admin with last name as link text
{{user(admin, format=lastname)}}
Link to user profile with login name admin with first name and last name as link text
{{user(admin, format=firstname_lastname)}}
Display name of currently logged in user with username as text
{{user(current_user, text=true)}}
Display name of currently logged in user with username
{{user(current_user)}}
Vimeo¶
Vimeo wiki macro for Redmine.
-
{{vimeo(video [, width=WIDTH, height=HEIGHT, autoplay=BOOL])}} Show Vimeo embedded video
Parameters: - video (string) – Vimeo video code, e.g. 142849533. This is the part after https://vimeo.com/
- width (int) – video width
- height (int) – video height
- autoplay (bool) – auto play video, if true
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Vimeo video with video 142849533 (iframe) and default size 640x360
{{vimeo(142849533)}}
Vimeo video with size 853x480
{{vimeo(142849533, width=853, height=480)}}
Vimeo video and autoplay
{{vimeo(142849533, autoplay=true)}}
Youtube¶
Youtube wiki macro for Redmine.
-
{{youtube(video [, width=WIDTH, height=HEIGHT, autoplay=BOOL])}} Show Youtube embedded video
Parameters: - video (string) – Youtube video code, e.g. wvsboPUjrGc. This is the part after https://www.youtube.com/watch?v=
- width (int) – video width
- height (int) – video height
- autoplay (bool) – auto play video, if true
Scope¶
This macro works in all text fields with formatting support.
Examples¶
Youtube video with video wvsboPUjrGc (iframe) and default size 640x360
{{youtube(wvsboPUjrGc)}}
Youtube video with size 853x480
{{youtube(wvsboPUjrGc, width=853, height=480)}}
Youtube video with auto play
{{youtube(wvsboPUjrGc, autoplay=true)}}