CHEAT SHEET: Redmine Macros

Redmine standard installation Usage: Collaboration Redmine Knowledgebase Plugin Additionals Plugin
Usage: Functional Macro Example Usage: Collaboration Usage: Date & Time
Macro Example comments {{comments}} Macro Example Macro Example
child_pages {{child_pages}} kb {{kb(17)}} calendar {{calendar([year=YEAR,
comment_form {{comment_form}}
{{child_pages(depth=2)}} month=MONTH, show_weeks=BOOL,
article_id {{article_id(17)}} select=DATE)}}
vote(key) {{vote(key)}}
collapse {{collapse(view details…)
{{vote(key, descriptive text)}}
This is a block of text, collapsed article {{article(5)}} current_year {{current_year}}
{{vote(key, label)}}
by default.
}} category {{category(9)}} current_month {{current_month}}
Usage: Date & Time
hello_world {{hello_world}} Macro Example current_day {{current_day}}

include {{include(projectname:Foo)}} lastupdated_at {{lastupdated_at}} current_hour {{current_hour}}

new(yyyy-mm-dd) {{new(yyyy-mm-dd)}} Redmine DMSF Plugin
macro_list {{macro_list}} current_min {{current_min}}
{{new(yyyy-mm-dd, expire)}} Usage: Files & Folders
toc {{toc}} Macro Example current_weekday {{current_weekday}}
{{>toc}} recent {{recent}}
{{recent(10)}} dmsf(id) {{dmsf(17)}}
last_updated_at {{last_updated_at}}
Usage: Images & Style dmsf(id,My text) {{dmsf(17,File)}}
Usage: Users & Contacts recently_updated {{recently_updated([14])}}
Macro Example default is 5 days
Macro Example dmsff(ID) {{dmsff(5)}}
thumbnail {{thumbnail(image.png)}}
{{thumbnail(image.png, size=300, lastupdated_by {{lastupdated_by}}
title=Thumbnail)}} dmsff(ID,My folder) {{dmsff(5, Folder)}} Usage: Users
twitter(username) {{twitter(alphanodes}} Macro Example
group_users {{group_users(Team A)}}
Usage: Issues & Projects
Macro Example last_updated_by {{last_updated_by}}
Redmine Wiki Lists Plugin
Redmine Wiki Extensions Plugin project(project_name){{project(project_name)}}
{{project(project_name, alias)}} Usage: Issues & Projects user {{user(1)}}
Usage: Functional {{user(1, avatar=true)}}
{{project(project_identifer)}} Macro Example
Macro Example {{project(project_identifer, {{user(admin, avatar=true)}}
ref_issues {{ref_issues([options]..., {{user(1, format=frstname)}}
count {{count}} alias)}} [column]...)}}
{{show_count}}
wiki(project_name, wiki_page) Options: Usage: Projects, Issues & Comments
fn {{fn(word,description)}} {{wiki(project_name, wiki_page)}} -s[=WORD[|WORD]..] Macro Example
{{wiki(project_name, wiki_page, alias)}} select issues that contain WORDs in subject.
Footer Create a page named „Footer“ in {{wiki(project_identifer, wiki_page)}} issue {{issue([OPTIONS])}}
-d[=WORD[|WORD]..]
order to see it‘s content at the {{wiki(project_identifer, wiki_page, alias)}} {{issue(1)}}
select issues that contain WORDs in description.
bottom of every page {{issue(1, format=full)}}
-w[=WORD[|WORD]..]
{{issue(http://redmine.url/issues/1#note-3)}}
select issues that contain WORDs in subject or
new_page {{new_page}} description.
Options:
-p[=IDENTIFIER]
popularity {{popularity(10)}} url (string or note_id)
Specify the project by identifer.
Redmine CRM Plugin format=(string). e.g. full, text, short, link
-i=CUSTOM_QUERY_ID
tagcloud {{tagcloud}} id (int)
Usage: Users & Contacts Use custom query by id.
note_id (int). To link to an issue comment
-q=CUSTOM_QUERY_NAME
taggedpages(tagname) Macro Example Use custom query by query name.
{{taggedpages(tag)}} contact {{contact(contact_ID)}} projects {{projects}}
-f:ATTRIBUTE[=WORD[WORD...]]
{{taggedpages(tag1[tag2,…],project)}} {{contact(John Smith)}} {{projects(title=My project list)}}
Additional flter.
{{projects(with_create_issues=true)}}
Usage: Images & Styles avatar {{contact_avatar(contact_ID)}} Available columns:
project fxed_version
Macro Example
deal {{deal(deal_ID)}} tracker start_date
div_start_tag {{div_start_tag(id_name)}} parent due_date
{{div_start_tag(class_name)}} note {{contact_note(ContactNote_ID)}} status estimated_hours
{{div_start_tag(id_name, priority done_ratio
Version 12/2017

class_name)}} subject created

author
div_end_tag {{div_end_tag}} assigned_to
updated_on
category

This Redmine macro cheat sheet is provided by AlphaNodes GmbH → https://alphanodes.com

 CHEAT SHEET: Redmine Macros
Additionals Plugin Usage: Social media Redmine DB Plugin
Usage: Informational Macro Example Usage: Assets
Macro Example gist {{gist(GistName}} Macro Example
cryptocampare {{cryptocompare(Options)}} db {{db(17)}}
iframe {iframe(url [, width=INT, height=INT,
{{cryptocompare(fsyms=BTC, type=header)}}
with_link=BOOL])}}
db_query {{db_query(7)}}
Options (widget type has to support it):
Options:
fsym (string) db_tag {{db_tag(Server)}}
width (int)
tsym (string) {{db_tag(Server, title=Wichtig)}}
heigth (int)
fsyms (string). E.g. BTC, ETH, LTC
url (string)
tsyms (string). E.g. EUR, USD db_tag_count {{db_tag_count(Server)}}
with_link (bool)
period (string) – 1D, 1W, 2W, 1M, 3M, 6M, 1Y {{db_tag_count(Server, all_projects=true)}}
reddit {{reddit(redmine)}}
type (string) – advanced, chart (default), converter, header,
{{reddit(r/redmine)}}
header_v2, header_v3, historical, list, news, summary,
tabbed, titles
slideshare {{slideshare([Options])}}
{{slideshare(5793230, slide=5)}}
gmap {{gmap([Options])}} Redmine Passwords Plugin
{{gmap(q=Munich)}}
Options: Usage: Security
{{gmap(mode=directions,
key (string) – key code from end of URL
origin=Munich+Implerstr, Macro Example
width (int)
destination=Roma)}}
height (int) password {{password(17)}}
slide (int)
Options: password_query {{password_query(7)}}
q (string) – city or location
twitter {{twitter(alphanodes)}}
mode (string) – place, directions, search, view
{{twitter(@alphanodes)}} password_tag {{password_tag(Login)}}
width (int)
{{twitter(#redmine)}} {{password_tag(Login, title=Wichtig)}}
heigth (int)
password_tag_count {{password_tag_count(Login)}}
meteoblue {{meteoblue(location[Options])}}
vimeo {{vimeo(video[Options])}} {{password_tag_count(Login, all_projects=true)}}
{{vimeo(1234566, width=800)}}
Options:
{{vimeo(1234566, autoplay=true)}}
location (string) – weather location e.g. Munich germany is
münchen_deutschland_2867714 (part after
Options:
https://www.meteoblue.com/en/weather/forecast/week/)
width (int)
width (int)
heigth (int) Legende
height (int)
video (string)
color (bool)
autoplay (bool) Redmine Standard
pictoicon (bool)
maxtemperature (bool)
youtube {{youtube(video[Options])}} Wiki Extensions Plugin
mintemperature (bool)
{{youtube(1234566, width=800)}}
windspeed (bool)
{{youtube(1234566, autoplay=true)}} CRM Plugin
winddirection (bool)
uv (bool)
Options: Knowledgebase Plugin
humidity (bool)
width (int)
precipitation (bool)
heigth (int) DMSF Plugin
precipitationprobability (bool)
video (string)
spot (bool)
autoplay (bool) Wiki Lists Plugin
tradingview {{tradingview([Options])}}
{{tradingview(symbol=NASDAQ:AMZN, locale=en)}} Additionals Plugin

Options: DB Plugin
symbol (string)
width (int) Passwords Plugin
height (int)
interval (string)
timezone (string)
theme (string)
style (int)
Version 12/2017

locale (string)
toolbar_bg (string)
enable_publishing (bool)
allow_symbol_change (bool)
hideideasbutton (bool)

This Redmine macro cheat sheet is provided by AlphaNodes GmbH → https://alphanodes.com