Nuevo plugin Additionals 2.0.20

This commit is contained in:
Manuel Cillero 2019-06-16 12:53:09 +02:00
parent a2a901b71b
commit 93e1e28683
354 changed files with 40514 additions and 0 deletions

View file

@ -0,0 +1,57 @@
Calendar
--------
Calendar wiki macros for Redmine.
.. function:: {{calendar([year=YEAR, month=MONTH, show_weeks=BOOL, select=DATE])}}
Show month calendar
:param int year: year to use, e.g. 2015
:param int month: month to use, e.g. 4
:param bool show_weeks: show week numbers if true
:param date select: date or dates, which should be highlighted
Scope
+++++
This macro only works in wiki page contexts.
Examples
++++++++
show calendar for current date
.. code-block:: smarty
{{calendar}}
show calendar for Juni in year ``2014``
.. code-block:: smarty
{{calendar(year=2014,month=6)}}
show calendar with week numbers
.. code-block:: smarty
{{calendar(show_weeks=true)}}
preselect a date
.. code-block:: smarty
{{calendar(select=2015-07-12)}}
preselect dates and show week numbers
.. code-block:: smarty
{{calendar(select=2015-07-12 2015-07-31, show_weeks=true)}}
preselect dates between 2016/3/13 and 2016/3/27
.. code-block:: smarty
{{calendar(select=2016-03-13:2016-03-27)}}

View file

@ -0,0 +1,53 @@
CryptoCompare
-------------
CryptoCompare wiki macro for Redmine.
See https://www.cryptocompare.com/dev/widget/wizard/ for more information.
.. function:: {{cryptocompare(options)}}
show CryptoCompare information
:param string fsym: default BTC
:param string tsym: default EUR
:param string fsyms: default BTC,ETH,LTC (if supported by widget type)
:param string tsyms: default EUR,USD (if supported by widget type)
:param string period: (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
:param string type: 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``
.. code-block:: smarty
{{cryptocompare(fsyms=BTC;ETH, type=header_v3)}}

View file

@ -0,0 +1,58 @@
Date
----
.. function:: {{date([TYPE])}}
Display current date
:param string TYPE: 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.
.. code-block:: smarty
{{date}}
Show current date with time
.. code-block:: smarty
{{date(current_date_with_time)}}
Show current year
.. code-block:: smarty
{{date(current_year)}}
Show current week number
.. code-block:: smarty
{{date(current_weeknumber)}}
Show date 2018-12-24 in right format, which is specified in Redmine Settings, which shows e.g. 24.12.2018
.. code-block:: smarty
{{date(2018-12-24)}}

View file

@ -0,0 +1,75 @@
Font Awesome
------------
Font Awesome wiki macro for Redmine.
.. function:: {{fa(icon [, class=CLASS, title=TITLE, text=TEXT, link=LINK, color=COLOR])}}
Displays a Font Awesome icon
:param string icon: font awesome icon name, e.g. adjust or fas_adjust
:param string class: additional css classes
:param string title: mouseover title
:param string text: text, which is displayed after font awesome icon
:param string link: link to this url
:param string color: css color code
Scope
+++++
This macro works in all text fields with formatting support.
Examples
++++++++
Show font awesome icon "fas fa-adjust"
.. code-block:: smarty
{{fa(adjust)}}
Show font awesome icon "fas fa-stack" and inverse
.. code-block:: smarty
{{fa(adjust, class=fa-inverse)}}
Show font awesome icon "fas fa-adjust" with size 4x
.. code-block:: smarty
{{fa(adjust, size=4x)}}
Show font awesome icon "fas fa-adjust" with title "Show icon"
.. code-block:: smarty
{{fa(fas_adjust, title=Show icon)}}
Show font awesome icon "fab fa-angellist"
.. code-block:: smarty
{{fa(fab_angellist)}}
Show font awesome icon "fas fa-adjust" and link it to https://www.redmine.org
.. code-block:: smarty
{{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
.. code-block:: smarty
{{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.

View file

@ -0,0 +1,30 @@
Gist
----
Github gist wiki macro for Redmine.
.. function:: {{gist(gist)}}
show Github gist
:param string gist: 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)
.. code-block:: smarty
{{gist(6737338)}}
Show Github gist ``plentz/6737338`` (with user name)
.. code-block:: smarty
{{gist(plentz/6737338)}}

View file

@ -0,0 +1,33 @@
Google Map
----------
Google map wiki macro for Redmine to implement a street map. There are various configuration options for presenting the GMap.
.. function:: {{gmap([q=QUERY, mode=MODE, width=WIDTH, height=HEIGHT])}}
Show Google map
:param string q: query, e.g. a city or location
:param string mode: place, directions, search, view oder streetview (default: search)
:param int width: widget width
:param int height: 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``
.. code-block:: smarty
{{gmap(Munich)}}
Another option is to show a widget for direction for example from Munich to Arco (Italy)
.. code-block:: smarty
{{gmap(mode=directions, origin=Munich+Implerstr, destination=Arco)}}

View file

@ -0,0 +1,24 @@
Members, Group
--------------
Group users macro for Redmine.
.. function:: {{group_users(group_name)}}
Show list of users in a user group (according the respective permissions)
:param string group_name: group name
Scope
+++++
This macro works in all text fields with formatting support.
Examples
++++++++
List all users of user group ``Team A``
.. code-block:: smarty
{{group_users(Team A)}}

View file

@ -0,0 +1,42 @@
Iframe
------
Iframe macro for Redmine.
.. function:: {{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.
:param string url: URL to website
:param int width: width (default is 100%)
:param int height: height (default is 485)
:param bool with_link: 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) <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>`_
Scope
+++++
This macro works in all text fields with formatting support.
Examples
++++++++
Show iframe of URL ``https://www.google.com/``
.. code-block:: smarty
{{iframe(https://www.google.com/)}}
Show iframe of URL https://www.google.com/ and show link to it
.. code-block:: smarty
{{iframe(https://www.google.com/, with_link: true)}}

View file

@ -0,0 +1,57 @@
Issue
-----
Issue wiki macro for Redmine.
.. function:: {{issue(url [, format=FORMAT, id=ISSUE_ID, note_id=COMMENT_ID])}}
Display a link to issue with subject (optional with an issue note)
:param string url: URL to an issue with issue id (and note_id)
:param string format: custom format of link name. Possible values: full, text, short or link. If not specified 'link' is used as default.
:param int id: issue id (if this is defined, it will be always used prioritized - before the parameter for URL)
:param int note_id: 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
.. code-block:: smarty
{{issue(1)}}
Link to issue with id and subject by using the URL
.. code-block:: smarty
{{issue(http://myredmine.url/issues/1)}}
Link to issue with id and subject and show comment 3
.. code-block:: smarty
{{issue(http://myredmine.url/issues/1#note-3)}}
Link to issue with subject (without id)
.. code-block:: smarty
{{issue(1, format=short)}}
Link to issue with tracker, subject and id
.. code-block:: smarty
{{issue(1, format=full)}}
Display subject of issue
.. code-block:: smarty
{{issue(1, format=text)}}

View file

@ -0,0 +1,13 @@
Last updated at
---------------
Last updated at wiki macro for Redmine.
.. function:: {{last_updated_at}}
show the timestamp when the wiki page was updated
Scope
+++++
This macro only works in wiki page contexts.

View file

@ -0,0 +1,13 @@
Last updated by
---------------
Last updated by wiki macro for Redmine.
.. function:: {{last_updated_by}}
show the name of user who updated the wiki page
Scope
+++++
This macro only works in wiki page contexts.

View file

@ -0,0 +1,54 @@
Members, Project
----------------
Project members macro for Redmine.
.. function:: {{members([project_name, title=TITLE, role=ROLE])}}
Show list of project members
:param string project_name: can be project identifier, project name or project id
:param string title: title to use for member list
:param string role: only list members with this role. If you want to use multiple roles as filters, you have to use a | as separator.
Scope
+++++
This macro works in all text fields with formatting support.
Examples
++++++++
List all members for all projects (with the current user permission)
.. code-block:: smarty
{{members}}
List all members for the project with the identifier of ``myproject``
.. code-block:: smarty
{{members(myproject)}}
List all members for the project with the identifier of ``myproject``, which
have the role ``Manager``
.. code-block:: smarty
{{members(myproject, role=Manager)}}
List all members for the project with the identifier of ``myproject``, which
have the role ``Manager`` or ``Team``
.. code-block:: smarty
{{members(myproject, role=Manager|Team)}}
List all members for the project with name ``My project title`` and with
box title ``My member list``
.. code-block:: smarty
{{members(My project title, title=My member list)}}

View file

@ -0,0 +1,44 @@
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.
.. function:: {{meteoblue(location [, days=DAYS, width=WIDTH, height=HEIGHT, color=BOOL, flags...])}}
Show weather widget from Meteoblue
:param string location: Weather location, e.g. münchen_deutschland_2867714. This is the part after https://www.meteoblue.com/en/weather/forecast/week/
:param int width: widget width
:param int height: widget height
:param bool color: color or monochrome
:param bool pictoicon: pictoicon
:param bool maxtemperature: maxtemperature
:param bool mintemperature: mintemperature
:param bool windspeed: windspeed
:param bool windgust: windgust
:param bool winddirection: winddirection
:param bool uv: uv
:param bool humidity: humidity
:param bool precipitation: precipitation
:param bool precipitationprobability: precipitationprobability
:param bool spot: spot
Scope
+++++
This macro works in all text fields with formatting support.
Examples
++++++++
Show widget for Munich with ``münchen_deutschland_2867714`` (iframe)
.. code-block:: smarty
{{meteoblue(münchen_deutschland_2867714)}}
Show widget for Munich with ``münchen_deutschland_2867714`` (iframe) and uv information
.. code-block:: smarty
{{meteoblue(münchen_deutschland_2867714, uv=true)}}

View file

@ -0,0 +1,48 @@
New issue
---------
Create a link for "New issue" for the current user.
.. function:: {{new_issue([project_name, name=NAME])}}
Show link to create new issue
:param string project_name: 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.
:param string name: 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
.. code-block:: smarty
{{new_issue}}
Link to create new issue in project with the identifier of ``myproject``
.. code-block:: smarty
{{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``
.. code-block:: smarty
{{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
.. code-block:: smarty
{{new_issue(name_de: Ticket hier bitte anlegen)}}

View file

@ -0,0 +1,37 @@
Projects
--------
Projects wiki macro for Redmine.
.. function:: {{projects([title=TITLE, with_create_issue=BOOL])}}
Lists projects of the current user
:param string title: title to use for project list
:param bool with_create_issue: 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
.. code-block:: smarty
{{projects}}
List all projects of the current users and adds the heading ``My project list``
.. code-block:: smarty
{{projects(title=My project list)}}
List all project with link to create new issue, which I am member of
.. code-block:: smarty
{{projects(with_create_issue=true)}}

View file

@ -0,0 +1,30 @@
Recently updated
----------------
Recently updated wiki macro for Redmine.
.. function:: {{recently_updated([days])}}
show the list of the pages that were changed recently.
:param int days: 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)
.. code-block:: smarty
{{recently_updated}}
List last updated pages of the last 15 days
.. code-block:: smarty
{{recently_updated(15)}}

View file

@ -0,0 +1,37 @@
Reddit
------
Reddit wiki macro for Redmine.
.. function:: {{reddit(name)}}
show link to Reddit
:param string name: Reddit subject or user name
Scope
+++++
This macro works in all text fields with formatting support.
Examples
++++++++
Show link to reddit subject ``r/redmine``
.. code-block:: smarty
{{reddit(redmine)}}
or
.. code-block:: smarty
{{reddit(r/redmine)}}
Show link to reddit user profile ``u/redmine``
.. code-block:: smarty
{{reddit(u/redmine)}}

View file

@ -0,0 +1,37 @@
Redmine.org Issue
-----------------
Redmine.org issue wiki macro for Redmine.
.. function:: {{redmine_issue(url [, title=TITLE])}}
Display a link to an issue on redmine.org
:param string url: this can be an absolute path to an redmine.org issue or an issue id
:param string title: 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
.. code-block:: smarty
{{redmine_issue(1333)}}
Link to redmine.org issue with issue id and anchor
.. code-block:: smarty
{{redmine_issue(1333#note-6)}}
Link to redmine.org issue with absolute url
.. code-block:: smarty
{{redmine_issue(http://www.redmine.org/issues/12066)}}

View file

@ -0,0 +1,38 @@
Redmine.org Wiki page
---------------------
Redmine.org wiki page macro for Redmine.
.. function:: {{redmine_wiki(url [, name=NAME, title=TITLE])}}
Display a link to an issue on redmine.org
:param string url: this can be an absolute path to an redmine.org issue or an issue id
:param string name: name to display for link, if not specified, wiki page name is used
:param string title: 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
.. code-block:: smarty
{{redmine_wiki(RedmineInstall)}}
Link to redmine.org wiki page with page name and anchor
.. code-block:: smarty
{{redmine_wiki(FAQ#How-do-I-create-sub-pages-parentchild-relationships-in-the-wiki)}}
Link to redmine.org wiki page with absolute url
.. code-block:: smarty
{{redmine_wiki(https://www.redmine.org/projects/redmine/wiki/RedmineInstall)}}

View file

@ -0,0 +1,39 @@
Slideshare
----------
Slideshare wiki macro for Redmine.
.. function:: {{slideshare(key [, width=WIDTH, height=HEIGHT, slide=SLIDE])}}
Show slideshare embedded slide
:param string key: Slideshare embedded key code, e.g. 57941706. This is the part is the last number in url: http://de.slideshare.net/AnimeshSingh/caps-whats-best-for-deploying-and-managing-openstack-chef-vs-ansible-vs-puppet-vs-salt-57941706
:param int width: width
:param int height: height
:param int slide: Slide page
Scope
+++++
This macro works in all text fields with formatting support.
Examples
++++++++
Slideshare slide for slide ``57941706`` (iframe) and default size 595x485
.. code-block:: smarty
{{slideshare(57941706)}}
Slideshare slide with size 514x422
.. code-block:: smarty
{{slideshare(57941706, width=514, height=422)}}
Slideshare slide and start with page 5
.. code-block:: smarty
{{slideshare(57941706, slide=5)}}

View file

@ -0,0 +1,37 @@
TradingView
-----------
TradingView wiki macro for Redmine.
See https://www.tradingview.com/widget/ for more information.
.. function:: {{tradingview(options)}}
show TradingView chart
:param int width: default 640
:param int height: default 480
:param string symbol: default NASDAQ:AAPL
:param string interval: default W
:param string timezone: default Europe/Berlin
:param string theme: default White
:param int style: default 2
:param string locale: default de
:param string toolbar_bg: default #f1f3f6
:param bool enable_publishing: default false
:param bool allow_symbol_change: default true
:param bool hideideasbutton: default true
Scope
+++++
This macro works in all text fields with formatting support.
Examples
++++++++
Show chart with symbol ``NASDAQ:AMZN`` and use English locale
.. code-block:: smarty
{{tradingview(symbol=NASDAQ:AMZN, locale=en)}}

View file

@ -0,0 +1,37 @@
Twitter
-------
Twitter wiki macro for Redmine.
.. function:: {{twitter(profile)}}
show link to Twitter profile
:param string profile: 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``
.. code-block:: smarty
{{twitter(alphanodes)}}
or
.. code-block:: smarty
{{twitter(@alphanodes)}}
Show link to hashtag ``#redmine``
.. code-block:: smarty
{{twitter(#redmine)}}

View file

@ -0,0 +1,62 @@
User
----
User wiki macro for Redmine.
.. function:: {{user_name [, format=FORMAT, avatar=BOOL])}}
Display link to user profile
:param string user_name: username (login name) or user id of the user
:param string format: 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.
:param bool avatar: show avatar, if true
Scope
+++++
This macro works in all text fields with formatting support.
Examples
++++++++
Link to user profile with id 1
.. code-block:: smarty
{{user(1)}}
Link to user profile with id 1 and show user avatar
.. code-block:: smarty
{{user(1, avatar=true)}}
Link to user profile with login name ``admin`` and show user avatar
.. code-block:: smarty
{{user(admin, avatar=true)}}
Link to user profile with login name ``admin`` with username as link text
.. code-block:: smarty
{{user(admin, format=username)}}
Link to user profile with login name ``admin`` with first name as link text
.. code-block:: smarty
{{user(admin, format=firstname)}}
Link to user profile with login name ``admin`` with last name as link text
.. code-block:: smarty
{{user(admin, format=lastname)}}
Link to user profile with login name ``admin`` with first name and last name as link text
.. code-block:: smarty
{{user(admin, format=firstname_lastname)}}

View file

@ -0,0 +1,39 @@
Vimeo
-----
Vimeo wiki macro for Redmine.
.. function:: {{vimeo(video [, width=WIDTH, height=HEIGHT, autoplay=BOOL])}}
Show Vimeo embedded video
:param string video: Vimeo video code, e.g. 142849533. This is the part after https://vimeo.com/
:param int width: video width
:param int height: video height
:param bool autoplay: 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
.. code-block:: smarty
{{vimeo(142849533)}}
Vimeo video with size 853x480
.. code-block:: smarty
{{vimeo(142849533, width=853, height=480)}}
Vimeo video and autoplay
.. code-block:: smarty
{{vimeo(142849533, autoplay=true)}}

View file

@ -0,0 +1,39 @@
Youtube
-------
Youtube wiki macro for Redmine.
.. function:: {{youtube(video [, width=WIDTH, height=HEIGHT, autoplay=BOOL])}}
Show Youtube embedded video
:param string video: Youtube video code, e.g. wvsboPUjrGc. This is the part after https://www.youtube.com/watch?v=
:param int width: video width
:param int height: video height
:param bool autoplay: 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
.. code-block:: smarty
{{youtube(wvsboPUjrGc)}}
Youtube video with size 853x480
.. code-block:: smarty
{{youtube(wvsboPUjrGc, width=853, height=480)}}
Youtube video with auto play
.. code-block:: smarty
{{youtube(wvsboPUjrGc, autoplay=true)}}