Nuevo plugin Additionals 2.0.20

plugins/additionals/docs/Makefile

@@ -0,0 +1,230 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+	$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  epub3      to make an epub3"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+	@echo "  dummy      to check syntax errors of document sources"
+
+.PHONY: clean
+clean:
+	rm -rf $(BUILDDIR)/*
+
+.PHONY: html
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: dirhtml
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: singlehtml
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+.PHONY: pickle
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+.PHONY: json
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+.PHONY: htmlhelp
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+.PHONY: qthelp
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/additionals.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/additionals.qhc"
+
+.PHONY: applehelp
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+.PHONY: devhelp
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/additionals"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/additionals"
+	@echo "# devhelp"
+
+.PHONY: epub
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+.PHONY: epub3
+epub3:
+	$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
+	@echo
+	@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
+
+.PHONY: latex
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+.PHONY: latexpdf
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: latexpdfja
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: text
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+.PHONY: man
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+.PHONY: texinfo
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+.PHONY: info
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+.PHONY: gettext
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+.PHONY: changes
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+.PHONY: linkcheck
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+.PHONY: doctest
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+.PHONY: coverage
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+.PHONY: xml
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+.PHONY: pseudoxml
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+
+.PHONY: dummy
+dummy:
+	$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
+	@echo
+	@echo "Build finished. Dummy builder generates no files."

plugins/additionals/docs/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst

plugins/additionals/docs/conf.py

@@ -0,0 +1,94 @@
+# -*- coding: utf-8 -*-
+
+import sys
+import os
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.mathjax',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = []
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'additionals'
+copyright = u'2013-2018, AlphaNodes GmbH'
+author = u'Alexander Meindl'
+
+# The short X.Y version.
+version = u'2.0.13'
+# The full version, including alpha/beta/rc tags.
+release = u'2.0.13'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+#html_static_path = ['_static']
+html_static_path = []
+
+# If false, no index is generated.
+html_use_index = True
+
+# If true, links to the reST sources are added to the pages.
+html_show_sourcelink = False
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+html_show_sphinx = False
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'additionalsdoc'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'additionals.tex', u'Additionals Documentation',
+     u'Alexander Meindl', 'manual'),
+]
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'additionals', u'additionals Documentation',
+     [author], 1)
+]
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'additionals', u'additionals Documentation',
+     author, 'additionals', 'One line description of project.',
+     'Miscellaneous'),
+]

plugins/additionals/docs/index.rst

@@ -0,0 +1,216 @@
+.. Additionals documentation master file, created by
+   sphinx-quickstart on Sat Apr 23 16:31:21 2016.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. _Redmine: https://www.redmine.org
+.. _Ruby: https://www.ruby-lang.org
+.. _Gemfile: https://github.com/alphanodes/additionals/blob/master/Gemfile
+
+Welcome to Additionals Plugin for Redmine
+=========================================
+
+Additionals is a `Redmine`_ plugin for customizing Redmine, providing wiki macros and act as a library/function provider for other Redmine plugins.
+
+This plugin is the successor of `Redmine Tweaks <https://github.com/alphanodes/redmine_tweaks>`_
+
+
+* Documentation: https://additionals.readthedocs.io
+* Redmine.org plugin page: https://www.redmine.org/plugins/additionals
+* Github: https://github.com/alphanodes/additionals
+
+.. image:: https://readthedocs.org/projects/additionals/badge/?version=latest
+   :target: https://additionals.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+
+.. image:: https://api.codeclimate.com/v1/badges/d92c0bda57f80e7c76b7/maintainability
+   :target: https://codeclimate.com/github/AlphaNodes/additionals/maintainability
+   :alt: Maintainability
+
+.. image:: https://travis-ci.org/AlphaNodes/additionals.svg?branch=master
+   :target: https://travis-ci.org/AlphaNodes/additionals
+
+.. image:: https://img.shields.io/badge/rate%20at-redmine.org-blue.svg?style=flat
+   :target: https://www.redmine.org/plugins/additionals
+   :alt: Rate at redmine.org
+
+Requirements
+------------
+
++--------------------+----------------------+
+| `Redmine`_ version | >= 3.4.0             |
++--------------------+----------------------+
+| `Ruby`_ version    | >= 2.3.0             |
++--------------------+----------------------+
+| Gem packages       | see `Gemfile`_       |
++--------------------+----------------------+
+
+
+Installation
+------------
+
+Install ``additionals`` plugin for `Redmine`_.
+
+.. code-block:: bash
+
+  $ cd $REDMINE_ROOT
+  $ git clone -b v2-stable git://github.com/alphanodes/additionals.git plugins/additionals
+  $ bundle install --without development test
+  $ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
+  $
+  $ # if you want to use smiley/emoji legacy support, you have to put emoji icons to
+  $ # $REDMINE_ROOT/public/images/emoji
+  $ # To obtain image files, run the gemoji extract command on macOS Sierra or later:
+  $ bundle exec gemoji extract public/images/emoji
+  $
+  $ # if you to not have macOS, you can put these files manually to $REDMINE_ROOT/public/images/emoji
+  $ # see https://github.com/github/gemoji for more infos
+
+Restart your application server (apache with passenger, nginx with passenger, unicorn, puma, etc.) and ``Additionals`` is ready to use.
+
+More information about installation of Redmine plugins, you can find in the official `Redmine plugin documentation <https://www.redmine.org/projects/redmine/wiki/Plugins>`_.
+
+
+Update
+------
+
+Update ``additionals`` plugin for `Redmine`_.
+
+.. code-block:: bash
+
+  $ cd $REDMINE_ROOT/plugins/additionals
+  $ git pull
+  $ cd ../..
+  $ bundle install --without development test
+  $ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
+
+Restart your application server (apache with passenger, nginx with passenger, unicorn, puma, etc.) and ``Additionals`` is ready to use.
+
+
+Uninstall
+---------
+
+Uninstall ``additionals`` plugin for `Redmine`_.
+
+.. code-block:: bash
+
+  $ cd $REDMINE_ROOT
+  $ bundle exec rake redmine:plugins:migrate NAME=additionals VERSION=0 RAILS_ENV=production
+  $ rm -rf plugins/additionals public/plugin_assets/additionals
+
+
+Features
+--------
+
+* use "Project guide" on project overview page
+* global header for all projects
+* global footer for all projects
+* welcome text for login page
+* global sidebar content support
+* set info message above new ticket (e.g. for guidelines)
+* wiki macros for:
+
+  * cryptocompare
+  * date
+  * fa
+  * gihub gist
+  * gmap
+  * group_users
+  * iframe
+  * issues
+  * members
+  * meteoblue
+  * new_issue
+  * projects
+  * reddit
+  * redmine.org issue and wiki page (redmine_issue and reminde_wiki)
+  * slideshare
+  * tradingview
+  * twitter
+  * user
+  * vimeo
+  * youtube
+
+* macro list with all available macros at /help/macros
+* macro button for wiki toolbar with available macros with project and permission context support
+* option to remove "My page" and/or "Help" from top menu
+* customize top menu items
+* disable (hide) modules for projects
+* open external urls in new window
+* smiley/emoji legacy support
+* anonymize referrer for external urls
+* hide role in project memberbox
+* change issue author
+* spam protection on registration form
+* add involved issue users as watcher automatically
+* create issue on user profile
+* "assign to me" link on issue
+* change issue state on sidebar
+* configurable issue rules
+
+  * freeze closed issue
+  * closing issue with open sub issues
+  * change assigned_to automatically, if issue status changes
+  * assigned_to has changed, but status change is required, too
+
+
+Developer features
+------------------
+
+As Redmine does not support asset pipeline, we need to install Javascript plugins as Redmine plugins to load them globally.
+
+If no common files are used as library plugin, every plugin has to deliver the same files. And if more
+than one version of a library is delivered with each Redmine plugin, there is a problem.
+
+Therefore if developer uses this plugin for the provided libraries, everything works smoothly.
+Don't worry, if you only need a subset of the provided libraries. If you do not load a library, it is not used.
+
+It provides :
+
+* `bootstrap-datepicker 1.8.0 <https://github.com/uxsolutions/bootstrap-datepicker>`_
+* `d3 3.5.17 <https://d3js.org/>`_
+* `d3plus v2.0.0-alpha.17 <https://d3plus.org/>`_
+* `FontAwesome 5.8.0 <https://fontawesome.com/>`_
+* `mermaid 8.0.0 <https://github.com/knsv/mermaid/>`_
+* `nvd3 1.8.6 <https://github.com/novus/nvd3>`_
+* `ZeroClipboard 2.3.0 <https://github.com/zeroclipboard/zeroclipboard>`_
+
+And a set of various Rails helper methods (see below).
+
+It provides the following Rails helper methods :
+
+Libraries assets loader
+-----------------------
+
+.. code-block:: ruby
+
+  additionals_library_load(module_name)
+
+
+This method loads all JS and CSS files needed by the required module.
+
+The following modules are available :
+
+* d3
+* d3plus
+* mermaid
+* nvd3
+* font_awesome
+* notify
+* zeroclipboard
+
+
+Contact and Support
+--------------------
+
+I am glad about your feedback on the plugin, `pull requests <https://github.com/alphanodes/additionals/pulls>`_, `issues <https://github.com/alphanodes/additionals/issues>`_, whatever. Feel free to contact me for any questions.
+
+
+.. toctree::
+    :maxdepth: 2
+
+    manual
+    macros
+    tasks
+    new_feature
+    changelog

plugins/additionals/docs/macros.rst

@@ -0,0 +1,32 @@
+Macros
+======
+
+These wiki macros are available with Additionals.
+
+If a parameter is in brackets, this parameter is optional.
+
+.. include:: macros/calendar.rst
+.. include:: macros/cryptocompare.rst
+.. include:: macros/date.rst
+.. include:: macros/fa.rst
+.. include:: macros/gist.rst
+.. include:: macros/gmap.rst
+.. include:: macros/group_users.rst
+.. include:: macros/iframe.rst
+.. include:: macros/issue.rst
+.. include:: macros/last_updated_at.rst
+.. include:: macros/last_updated_by.rst
+.. include:: macros/meteoblue.rst
+.. include:: macros/members.rst
+.. include:: macros/new_issue.rst
+.. include:: macros/projects.rst
+.. include:: macros/recently_updated.rst
+.. include:: macros/reddit.rst
+.. include:: macros/redmine_issue.rst
+.. include:: macros/redmine_wiki.rst
+.. include:: macros/slideshare.rst
+.. include:: macros/tradingview.rst
+.. include:: macros/twitter.rst
+.. include:: macros/user.rst
+.. include:: macros/vimeo.rst
+.. include:: macros/youtube.rst

plugins/additionals/docs/macros/calendar.rst

@@ -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)}}

plugins/additionals/docs/macros/cryptocompare.rst

@@ -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)}}

plugins/additionals/docs/macros/date.rst

@@ -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)}}

plugins/additionals/docs/macros/fa.rst

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

plugins/additionals/docs/macros/gist.rst

@@ -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)}}

plugins/additionals/docs/macros/gmap.rst

@@ -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)}}

plugins/additionals/docs/macros/group_users.rst

@@ -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)}}

plugins/additionals/docs/macros/iframe.rst

@@ -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)}}

plugins/additionals/docs/macros/issue.rst

@@ -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)}}

plugins/additionals/docs/macros/last_updated_at.rst

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

plugins/additionals/docs/macros/last_updated_by.rst

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

plugins/additionals/docs/macros/members.rst

@@ -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)}}

plugins/additionals/docs/macros/meteoblue.rst

@@ -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)}}

plugins/additionals/docs/macros/new_issue.rst

@@ -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)}}

plugins/additionals/docs/macros/projects.rst

@@ -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)}}

plugins/additionals/docs/macros/recently_updated.rst

@@ -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)}}

plugins/additionals/docs/macros/reddit.rst

@@ -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)}}

plugins/additionals/docs/macros/redmine_issue.rst

@@ -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)}}

plugins/additionals/docs/macros/redmine_wiki.rst

@@ -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)}}

plugins/additionals/docs/macros/slideshare.rst

@@ -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)}}

plugins/additionals/docs/macros/tradingview.rst

@@ -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)}}

plugins/additionals/docs/macros/twitter.rst

@@ -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)}}

plugins/additionals/docs/macros/user.rst

@@ -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)}}

plugins/additionals/docs/macros/vimeo.rst

@@ -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)}}

plugins/additionals/docs/macros/youtube.rst

@@ -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)}}

plugins/additionals/docs/manual.rst

@@ -0,0 +1,295 @@
+Manual
+======
+
+General section
+---------------
+
+The general section tab allows you to define some special behaviours for your Redmine installation.
+It is divided into two areas called ``Contents`` and ``Settings``.
+
+Contents
+++++++++
+
+The following plugin options are available to be edited by users with administration rights in the area **Contents**:
+
+* Text for login page. This section is for a short information on the login page below the login mask. For example who to contact in order to get Redmine access.
+* Global sidebar. Place your global information here, if needed. Use wiki links or available macros that can be seen by every one.
+* Project wide footer. In case you want to put some information about your company or for your imprint. Here you can also use wiki syntax for structuring your text.
+
+Settings
+++++++++
+
+And the following options can be edited by users with administratios rights in the area **Settings**:
+
+* Add "Go to top" link. If you have a lot of long pages, it is enabling users to easily return to the top of a page.
+* Change the option for ``External urls`` into default behaviour, open in new window or open with NoReferrer.
+* Activate the ``Legacy smileys / Emoji support`` if you want to use the manual smiley code (e.g. ``:kiss:``). This option is deactivated in the standard setting. If you already use a plugin that supports Smileys and Emojis this option should stay deactivated. For more info on Emoji-Browser support read http://caniemoji.com/. Have a look at the Emoji cheat sheet at https://www.webpagefx.com/tools/emoji-cheat-sheet for available Emoji-Codes.
+
+.. note:: Please restart the application server, if you make changes to the external urls settings as well as if you activate the Smileys and Emoji symbol support.
+
+.. note:: You can use the following manual smiley codes: :), =), :D, =D, :'(, :(, ;), :P, :O, :/, :S, :|, :X, :*, O:), >:), B), (!), (?), (v), (x), (/) and @}->-
+
+Overview page section
+---------------------
+
+If you click on this tab you get to the area, where you can customize contents and settings for your overview page in Redmine.
+These settings allows you to define some special behaviours for your Redmine installation.
+It is divided into two areas called ``Contents`` and ``Settings``.
+
+Contents
+++++++++
+
+The following plugin options are available to be edited by users with administration rights in the area **Contents**:
+
+* Overview page, right. Place information here you want to display at the right side of your overview page.
+* Overview page, top. Place information here you want to display at the top of your overview page.
+* Overview page, bottom. Place information here you want to display on the bottom of your overview page.
+
+All text input fields allow wiki syntax. Keep your text information as short as possible. In case you want to write prosa, you may also link to a wiki page with further information.
+
+Settings
+++++++++
+
+Changes you can make in the area **Settings** are:
+
+* Remove **Latest news** from overview page in case you do not use the **News** function very often. *Remember:* Old news is bad news.
+
+Wiki section
+------------
+
+If you click on this tab you get to the area, where users with administration rights can customize contents and settings for your Wiki pages in Redmine.
+It is divided into two areas called **Contents** and **PDF Wiki settings**.
+
+Contents
+++++++++
+
+Changes you can make in the area **Contents** are:
+
+=========================  ===========================================================================================
+Field                      Description
+=========================  ===========================================================================================
+Global wiki sidebar        Here you can implement useful macros like a display of your page hierarchy.
+                           But remember - only people with the correspondent rights will get a display of the content.
+Project wide wiki header   You can also implement useful macros in this section.
+Project wide wiki footer   For example to implement some date or author macros (e.g. last_updated_at, last_updated_by)
+=========================  ===========================================================================================
+
+.. note:: Use simple text, macros and wiki syntax for your content.
+
+PDF Wiki settings
++++++++++++++++++
+
+Changes you can make in the area **PDF Wiki settings** are:
+
+=================================  =====================================================================================================
+Field                              Description
+=================================  =====================================================================================================
+Remove Wiki title from PDF view    When activated the general Wiki title info in the page header of the PDF viewl will not be displayed.
+Remove attachments from PDF view   When activated the attachments will not be displayed in the PDF view of a Wiki page.
+=================================  =====================================================================================================
+
+
+Macro section
+-------------
+
+This section lists all available macros that the logged in user can use with the macro button of the wiki toolbar. If you leave them deactivated they are all available for selection. Macros marked here are not offered for selection. This allows you to limit the scope of the list for a better usability.
+
+
+.. figure::  images/macro-settings.png
+   :align:   center
+
+If all macros are deactivated the *Macro button* of the Wiki toolbar will disappear.
+
+.. note:: If you deactivate some macros here this does not mean the user may not implement them. All available macros of installed plugins will work even if they are not part of the macro button. The macro button is just a little helper for Redmine users to make it easier for them to use macros or to remember them.
+
+
+
+Issues section
+--------------
+
+Here you can define issue rules, which are used in issues of all projects as well as special issue content and other settings.
+
+Contents
+++++++++
+
+The following plugin options are available to be edited by users with administration rights in the area **Content**:
+
+* Note for new issues. Use this section if you want to place important issue notes above every new issue. Keep it short and use a link to a common wiki page with further information.
+
+.. note:: You can use wiki syntax for your text, but use it wisely.
+
+Settings
+++++++++
+
+The following options are available at the moment in the area **Settings** where you can define rules which will be used in all projects:
+
+* New issue on user profile. Activate this option in case you want to display the symbol link ''New issue'' on a user's profile page in the top right corner in order to add a new issue for this user directly from it's user profile page.
+* Show ''Assign to me'' on issue. Activate this option if you want to display the symbol link ''Assign to me'' in the issue overview page of an issue that you are able to assign it directly to yourself without *editing* the issue. The link is only shown to users who are also members in the correspondent project.
+* Issue status on sidebar. Activate this option in case you want to display a list of available issue status options in the right sidebar of the issue view page. One click on the option changes the issue status directly without opening the *edit* mode.
+
+.. note:: All three options above only work for users with appropriate issue tracking rights in the administration area "Roles and permissions" (view, add, edit).
+
+* Add involved users as watcher automatically. This means, everyone who is or has been involved in the issue (Assignee, Editor, Author etc.) will automatically be notified about further changes. At the same time the user finds an additional option in his user account edit mode called ``Autowatch involved issues`` (see figure 1). Deactivate this option if you don't want to be notified.
+* Issues with open sub-issues cannot be closed.
+* Disallow editing of closed issues (Freeze). This option should be activated if already closed issues should no longer be edited and commented.
+* If "Assignee" is unchanged and the issue status changed from x to y, than the author is assigned to the issue.
+
+.. figure::  images/account-preferences.jpg
+   :align:   center
+
+   Figure 1: Deactivate this option in your account in case you don't want to be notified even if the admin activated it.
+
+.. note:: Use Case for this option is that issues should be automatically assigned to author, if the status changes to *Approval*.
+
+* Current issue status x is only allowed if *Assignee* is the current user.
+
+.. note:: Is this function used in combination with the setting option *Issue status on sidebar* then the current user will automatically be assigned to the issue while changing the issue status. Use Case here: Users are only allowed to change the status to *In Progress* if they are the person who is actually working on the issue right now.
+
+* If ''Assigned to'' is not assigned to a user and the new issue status is x then the issue is auto assigned to the first group with users of the pre-defined role.
+
+.. note:: Use Case: The issue author does not know whom the issue should be assigned to. Or he is unsure who will be responsible for solving the task. In that case the issue for example with the status "To Do" is automatically assigned to the first group, which does contain a user of the pre-selected project manager role. Imagine you have a group called "Support", and there are users assigend to the "Manager" role, this support group will be automatically adressed to solve the issue when the issue author saves it.
+
+* Time log for issues required.
+
+.. note:: For each issue of the selected trackers, a time logging is necessary if the issue is to receive one of the defined status properties. The time logging is not required if there does no rights exist for the creation of time logging or if the user has the authorization *Time logging not required*.
+
+Please note, that a user with administration rights will always be able to do all those things a normal user is not allowed to.
+
+
+Projects section
+----------------
+
+The projects section offers several options for the user with admin rights to define texts, which will be displayed in the project areas of Redmine as well as disable special modules which should not be available for projects.
+
+* Project guide. The project guide box will provide every user information that is necessary for your Redmine projects. Here you can link to a wiki page or leave a text message.
+* ``Disable modules``, this feature will hide the selected modules in the project settings. Even if the module is enabled for use in the admin area it can not be selected by the project manager within the projects. Please note, if these modules already activated in existing projects, you will have to change and re-save the respective project settings first.
+
+.. note:: Use simple text, macros and wiki syntax for your content of the project guide. Make sure every one has access to the displayed information in case you link to a wiki page.
+
+Menu section
+------------
+
+First of all: This section is only visible in case the *Redmine HRM Plugin* is not installed. If you are also using the *Redmine HRM Plugin* this section disappears because the functionality is also an important part of ''HRM''.
+Otherwise, you can define here new top menu items and change some standard settings on the menu behaviour.
+
+.. note:: Please restart the application server, if you remove a menu item or change permissions as well as changing the custom help url.
+
+This area offers you the possibility to add up to 5 additional menu items to your Redmine main menu.
+The following input fields are available for each entry:
+
+============  ========================================
+Field         Description
+============  ========================================
+Name          Enter the name of the menu item.
+URL           Enter an URL starting with ``http://``
+Title         Enter an title (optional)
+Permissions   Select one ore more existing roles to which the menu item will be displayed.
+              Only members of selected roles will be displayed in this list.
+============  ========================================
+
+Settings
+++++++++
+
+In the **Settings** area of the menu tab there are the following functions available.
+
+* Enter a ``Custom help URL`` instead of linking to the help on Redmine.org. Make sure you restart your application server after your changes.
+* Remove ``My Page`` from top menu in order you don't want your users to use this page.
+
+Users section
+------------
+
+In case you want to use a SPAM protection for the user registration page you can activate a spam protection function in this area which is based on the honeypot strategy to provide a better user experience.
+We use the simple and flexible SPAM protection solution for Rails applications called ``invisible_captcha`` for it.
+
+In order to activate the checkbox ``SPAM protection for registration`` you must have enabled the registration process in your Redmine settings (Authentication - Self-registration). Otherwise it is not possible to use this function.
+
+.. note:: CAPTCHA is short for ``Completely Automated Public Turing test to tell Computers and Humans Apart``. It is a type of test to determine whether or not the user is human. The honeypot strategy is an alternative and fairly simple. It puts a field onto your form that humans won't fill out because they don't see it. Most spam bots search for forms, fill out every field and submit it. If the honeypot captcha field is filled out you know for sure it is a spam submission.
+
+Web APIs section
+----------------
+
+In case you want to use the Gmap Macro you have to implement your Google API Key into the field ``Google Maps Embed API Key`` first. After this you can use the Macro everywhere inside Redmine (Wiki, Issues - everywhere you use wiki syntax).
+
+
+Help menu
+---------
+
+We have implemented a help symbol in the global top menu of the header section that opens the new help menu.
+
+There you find useful manual links to various Redmine related topics which will automatically be implemented, when the plugin has been installed. The menu is divided into two parts.
+
+* There is a menu only for Redmine users without administration rights.
+* There is a menu extension for Redmine users with administration rights.
+
+The following menu items are currently implemented if a plugin is installed, that supports this additionals-function:
+
+* FontAwesome icons
+* Redmine macros (for more information see: Macros)
+* Redmine guide
+* Redmine changelog
+* Redmine Security Advisories
+* Redmine Upgrade
+
+Known external plugins that have a user manual and support this feature are currently:
+
+* additionals
+* redmine_privacy_terms
+* redmine_db
+* redmine_passwords
+
+
+Macros
+++++++
+
+Because it's sometimes hard to remember what kind of macros you can use in your Redmine installation we implemented the macro section.
+Here is simply displayed a list of all available Redmine macros of your installation, which are provided by Redmine in general and the installed Redmine plugins.
+Macros can be used in the Wiki of a project or as well as in the text area of an issue, for example. For more information on how to add macros use the Redmine help.
+
+
+Macro button for Wiki toolbar
+-----------------------------
+
+Many plugins are equipped with a number of useful macros. Unfortunately it is difficult for the normal user to find out which macros are usable without a look at the plugin documentation. With our new macro button for the Wiki toolbar we want to simplify the implementation of macros for users somehow and above all also promote. Because the use of macros belongs to the daily tools of the trade when dealing with the Wiki.
+
+
+.. figure::  images/additionals-makro-button.png
+   :align:   center
+
+   Figure 2: The Wiki toolbar macro button is a useful helper in order to select available project macros for your content.
+
+The macro button for the Wiki toolbar is acessible for every user of a project. For reasons of clarity, the list of available macros is restricted according to the following criteria.
+
+A user can see in the macro list:
+
+* the macros that can be used for the respective area. Macros that only work in the wiki are not available in the issue area and vice versa.
+* The macros, which he / she can use due to his / her role and the associated rights in the respective project.
+* only the macros of modules activated in the project. Macros for deactivated functions are hidden in the list.
+
+The function is easy to use. Just click the button with the left mouse. The dropdown list shows all your available macros. Select the one you want to use. The selected macro will be pasted to the cursor position. All you have to do is adapt missing parameters (if needed). That's it.
+
+A list of all available macros provided by the Additionals plugin is also available in this manual.
+
+
+Additional permissions
+----------------------
+
+The following role permissions are provided by the plugin and must be configured in the administration area ``Roles and permissions`` for the plugin functions to make sure it's working properly.
+
+**According to the selected Role you can activate / deactivate the following option:**
+
+* **Hide**. This option hides ``members`` of the selected role in the member box of each project overview page. Project members of other roles will still be listed. For example: You don't want others to catch a glimpse of your development team (Role: Development). So activate the role "Developer" to hide the list of your team members assigned to this role in this box. This function is also useful if your member box is too crowded.
+
+.. note:: This setting is also taken into account in all related query lists (e.g. issues, spent time etc.). So that the members with this role are also hidden there. **Important:** If the user has in one project a role, that allows him / her to view a specific "hidden role" this rule is not taken into account anymore.
+
+
+**According to the selected Role you can activate / deactivate the following permissions:**
+
+* **Show hidden roles in member box**. In case you have hidden roles in a project that should not be displayed you can give to some special user roles the permission to display the members however. *Important:* If someone in a project has a role that has this right, then this user sees all users everywhere.
+
+* **Edit issue author**. This permission will always record any changes made to the issue author. You can change the author only in the issue edit mode.
+
+* **Edit closed issues**. Set this option to those roles you don't want to edit closed issues. Normally a closed issue should not be edited anymore.
+
+* **Set author of new issues**. This permission should be set carefully, because in case you allow this, there is no history entry set for this. You will never know if the author has been originally someone else. Normally you don't want this.
+
+* **Log time to closed issues**. Our plugin does not allow time logs to closed issues. In case you still want to allow your members to log time to closed issues, you need to change the permission here.

plugins/additionals/docs/new_feature.rst

@@ -0,0 +1,16 @@
+You need a feature
+==================
+
+.. _AlphaNodes: https://alphanodes.com
+.. _Open-source: https://opensource.org/osd
+
+`Additionals`_ is `Open-source`_ and it is available at `Github <https://github.com/alphanodes/additionals>`_
+
+If you want to implement new features in it or if you want to change something, you can provide a pull request.
+
+The plugin is maintained by `AlphaNodes`_ for free as far as possible. In case you want a feature, which is not available
+and you are not capable of implementing it yourself, you can request this feature from `AlphaNodes`_.
+
+We are an `Open-source`_ company from Munich and we are usually getting payed for our
+time we spent on development. As we know our plugin at its best we are glad to take this job from you. In case the requested plugin changes still
+fit to the plugin purpose. Please, contact us in case you are interested in plugin development.

plugins/additionals/docs/tasks.rst

@@ -0,0 +1,90 @@
+Tasks
+=====
+
+Additionals comes with some rake tasks, which can be used for administration.
+
+drop_settings
+-------------
+
+.. function:: rake redmine:additionals:drop_settings plugin=PLUGIN
+
+    Drop settings for a plugin
+
+    :param string plugin: name of the plugin
+
+Examples
+++++++++
+
+Remove plugin settings for redmine plugin named ``redmine_plugin_example``
+
+.. code-block:: smarty
+
+  bundle exec rake redmine:additionals:drop_settings RAILS_ENV=production plugin="redmine_plugin_example"
+
+
+
+setting_set
+-----------
+
+.. function:: rake redmine:additionals:setting_set name=NAME setting=SETTING value=VALUE
+
+    Set settings for redmine or plugin
+
+    :param string name: name of the plugin or redmine (this is optional, if not defined redmine is used)
+    :param string setting: name of setting
+    :param string value: value for setting
+    :param string values: list of values (seperator is ,) to generate value array automaticaly
+
+Examples
+++++++++
+
+Set application title for Redmine
+
+.. code-block:: smarty
+
+  bundle exec rake redmine:additionals:setting_set RAILS_ENV=production setting="app_title" value="Redmine test instance"
+
+Set default modules for new projects
+
+.. code-block:: smarty
+
+  bundle exec rake redmine:additionals:setting_set RAILS_ENV=production setting="default_projects_modules" values="issue_tracking,time_tracking,wiki"
+
+
+Set plugin setting ``external_urls`` for plugin additionals to value 2
+
+.. code-block:: smarty
+
+  bundle exec rake redmine:additionals:setting_set RAILS_ENV=production name="additionals" setting="external_urls" value="2"
+
+
+setting_get
+-----------
+
+.. function:: rake redmine:additionals:setting_get name=NAME setting=SETTING
+
+    Get a setting of redmine or a plugin
+
+    :param string name: name of the plugin or redmine (this is optional, if not defined redmine is used)
+    :param string setting: name of setting
+
+Examples
+++++++++
+
+Get setting for ``external_urls`` of the plugin additionals
+
+.. code-block:: smarty
+
+  bundle exec rake redmine:additionals:setting_get RAILS_ENV=production name="additionals" setting="external_urls"
+
+Get ``app_title`` of redmine
+
+.. code-block:: smarty
+
+  bundle exec rake redmine:additionals:setting_get RAILS_ENV=production name="redmine" setting="app_title"
+
+Get ``app_title`` of redmine
+
+.. code-block:: smarty
+
+  bundle exec rake redmine:additionals:setting_get RAILS_ENV=production setting="app_title"