Actualizar plugin Additionals a 3.0.0
This commit is contained in:
parent
3d976f1b3b
commit
a26f5567af
399 changed files with 70374 additions and 4093 deletions
|
|
@ -24,13 +24,13 @@ master_doc = 'index'
|
|||
|
||||
# General information about the project.
|
||||
project = u'additionals'
|
||||
copyright = u'2013-2018, AlphaNodes GmbH'
|
||||
copyright = u'2013-2020, AlphaNodes GmbH'
|
||||
author = u'Alexander Meindl'
|
||||
|
||||
# The short X.Y version.
|
||||
version = u'2.0.13'
|
||||
version = u'3.0.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = u'2.0.13'
|
||||
release = u'3.0.0'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
|
|
|
|||
382
plugins/additionals/docs/dashboards.rst
Normal file
382
plugins/additionals/docs/dashboards.rst
Normal file
|
|
@ -0,0 +1,382 @@
|
|||
Dashboards
|
||||
==========
|
||||
|
||||
The additionals plugin version 3.0.0 comes with new dashboard support (Drag & Drop). The new *Dashboard* feature of the additionals plugin provides customizable areas to display and organize content from Redmine that support the functionality.
|
||||
|
||||
Specifically, you can customize the traditional Redmine main page, as well as the project overview pages according to your needs using the available dashboard blocks. The goal is to give the viewer an immediate overview of the issues or to display the metrics that are important to you.
|
||||
|
||||
The dashboard configuration takes place directly in Redmine:
|
||||
|
||||
* On the "Home" page
|
||||
* On the Project overview page
|
||||
* If other plugins are installed and support the dashboard functionality there might be also other areas. For example:
|
||||
|
||||
* Redmine HRM Plugin: HRM overview page
|
||||
|
||||
|
||||
.. figure:: images/dashboard-overview.png
|
||||
:align: center
|
||||
|
||||
Figure shows the main areas of the dashboard function
|
||||
|
||||
|
||||
**Dashboard examples**
|
||||
|
||||
With the *Dashboard* of the *additionals* plugin for Redmine you can for example:
|
||||
|
||||
* design the Redmine main page or project overview page so that the information relevant to you is displayed there at a glance.
|
||||
* create your own (private) dashboards independent of the predefined default dashboard and switch between them as needed.
|
||||
* create dashboards for other users or specific roles. As well as share your own dashboards publicly and make them available to your team.
|
||||
|
||||
|
||||
.. note::
|
||||
When using the dashboard function make sure you have already configured the *additionals permissions* the way you need them.
|
||||
|
||||
|
||||
**Dashboard permissions**
|
||||
|
||||
If you want to use the dashboard functionality you need to configure the permissions for the respective user roles, which are:
|
||||
|
||||
* Save dashboards
|
||||
* Set system dashboards
|
||||
* Share dashboards
|
||||
|
||||
|
||||
Dashboard: Home
|
||||
---------------
|
||||
|
||||
When accessing Redmine you probably get redirected to the "Home" page of the system. Users with appropriate permissions can modify the existing dashboard or add new dashboards by using the respective action links in the head section of the content area.
|
||||
|
||||
.. figure:: images/dashboard-home.png
|
||||
:align: center
|
||||
|
||||
Figure shows the Redmine *Home* page and where to find the dashboard actions
|
||||
|
||||
What you can do here is:
|
||||
|
||||
* use the "Edit dashboard" link for modifications
|
||||
* add a "New dashboard"
|
||||
* Enable sidebar or Disable sidebar
|
||||
* Switch to other existing dashboards
|
||||
* Add a dashboard block
|
||||
* Move, Delete or configure added dashboard blocks
|
||||
|
||||
|
||||
Edit Dashboard
|
||||
++++++++++++++
|
||||
|
||||
Users with appropriate permission can edit an existing dashboard by clicking the "Edit dashboard" link to open the edit window.
|
||||
|
||||
.. figure:: images/dashboard-edit.png
|
||||
:align: center
|
||||
|
||||
There you can make changes to the following fields:
|
||||
|
||||
Name
|
||||
The standard dashboard after the plugin installation is called "Welcome Dashboard". Modify it according to your needs.
|
||||
|
||||
Description
|
||||
The dashboard description will be displayed in the sidebar next to the dashboard as soon as a dashboard has been been selected to be active.
|
||||
|
||||
Visible
|
||||
There are various visibility settings for a dashboard like "to me only", "to any users", "to these roles only". If you want to mak a dashboard publicly available to all other users you have to choose the option "to any users". For a specific role choose the respective role instead.
|
||||
|
||||
Enable sidebar
|
||||
The dashboard sidebar contains some useful information for the user. Since it is sometimes disturbing, it is hidden. To prevent this you can select this option.
|
||||
|
||||
System default
|
||||
If you want to make your project dashboard system default, activate this option. So every user will have to work with it for the selected project.
|
||||
|
||||
Always expose
|
||||
If you want to make the system default dashboard name visible to the users in the head section of the dashboard page, you can activate this option. Then also the dashboard information in the sidebar is displayed.
|
||||
|
||||
Author
|
||||
You can change the dashboard author in case it is necessary. This is sometimes necessary, if you create a dasboard for someone else but want this person to be able to edit it afterwards. Or if a user will no longer be active in your Redmine system. *Important:* Only the author of a dashboard is able to edit or remove it. If the author is no longer an active user in your system, only a user with administration rights is allowed to modify the dashboard.
|
||||
|
||||
.. hint::
|
||||
In general, dashboards can only be edited by a single author. Not by a group. Users with administrator rights can change the author in an emergency.
|
||||
|
||||
.. note::
|
||||
The selection of the Author depends on the set permission for a role in the administration area. Only those user roles with the minimum permission **Save dashboards** or users with administration rights are selectable.
|
||||
|
||||
|
||||
|
||||
|
||||
New Dashboard
|
||||
+++++++++++++
|
||||
|
||||
Users with appropriate permission can add a new dashboard by clicking the "New dashboard" link in the "actions menu" to open the "New dashboard" window to fill out the following fields.
|
||||
|
||||
Name
|
||||
Assign a meaningful and unique name. The dashboard name will be displayed in the sidebar for later selection. If the sidebar has been disabled, you can select the dashboard from the "Actions" menu. The name must be unique.
|
||||
|
||||
Description
|
||||
The dashboard description will be displayed in the sidebar next to the dashboard as soon as a dashboard has been been selected to be active.
|
||||
|
||||
Visible
|
||||
There are various visibility settings for a dashboard like "to me only", "to any users", "to these roles only". If you want to mak a dashboard publicly available to all other users you have to choose the option "to any users". For a specific role choose the respective role instead.
|
||||
|
||||
Enable sidebar
|
||||
The dashboard sidebar contains some useful information for the user. Since it is sometimes disturbing, it is hidden. To prevent this you can choose this option.
|
||||
|
||||
System default
|
||||
If you want to make your project dashboard system default, activate this option. So every user will have to work with it for the selected project.
|
||||
|
||||
Always expose
|
||||
If you want to make the system default dashboard name visible to the users in the head section of the dashboard page, you can activate this option. Then also the dashboard information in the sidebar is displayed.
|
||||
|
||||
|
||||
Add Dashboard blocks
|
||||
++++++++++++++++++++
|
||||
|
||||
You can fill existing dashboards with content by using the select box "Add block".
|
||||
|
||||
.. figure:: images/dashboard-add-block.png
|
||||
:align: center
|
||||
|
||||
The blocks that are available here depend on the functions you are using and the plugins you have on your system. They need to support the dashboard functionality of the additionals plugin. Which is not hard to do so, because it's easy to implement for plugin developers.
|
||||
|
||||
1. In order to add a new dashboard block, just select the respective option from the selection box. The block will be added right away.
|
||||
|
||||
.. note::
|
||||
The selection displays only blocks, that are allowed to be displayed on the Redmine Home page. Others are not available for selection. Currently the following plugins have additionals dashboard support implemented: DB, Passwords, Reporting, HRM, Automation, additionals
|
||||
|
||||
|
||||
2. You probably need to position the block. In that case hover your mouse over the right block corner and grap the "Move" icon. Now position it somewhere else. If you need to remove it again use the "Delete" icon.
|
||||
|
||||
.. figure:: images/dashboard-actions.png
|
||||
:align: center
|
||||
|
||||
.. note::
|
||||
Be careful with the deletion option. If you delete a block it will be gone right away.
|
||||
|
||||
3. Some blocks can be configured. In that case hover your mouse over the right block corner and click the "Options" icon. The configuration option appears and you can make your changes. Done.
|
||||
|
||||
.. figure:: images/dashboard-options.png
|
||||
:align: center
|
||||
|
||||
.. note::
|
||||
Not every block is configurable and the block configuration may differ depending on the selection you have made. Some blocks may allow to change the column settings and other only the maximum entries, for example.
|
||||
|
||||
|
||||
|
||||
|
||||
Dashboard: Project overview
|
||||
---------------------------
|
||||
|
||||
The project overview page is also supporting the new Dashboard function. Users with appropriate permissions can modify the existing dashboard or add new dashboards by using the respective action links in the head section of the content area.
|
||||
|
||||
.. figure:: images/dashboard-projectoverview.png
|
||||
:align: center
|
||||
|
||||
Figure shows the project overview page and where to find the dashboard actions
|
||||
|
||||
What you can do here is:
|
||||
|
||||
* use the "Edit dashboard" link for modifications
|
||||
* add a "New dashboard"
|
||||
* Enable sidebar or Disable sidebar
|
||||
* Switch to other existing dashboards
|
||||
* Add a dashboard block
|
||||
* Move, Delete or configure added dashboard blocks
|
||||
|
||||
|
||||
Edit project dashboard
|
||||
++++++++++++++++++++++
|
||||
|
||||
Users with appropriate permission can edit an existing dashboard by clicking the "Edit dashboard" link to open the edit window. What fields are displayed also depends on the permission the role your user has.
|
||||
|
||||
.. figure:: images/dashboard-edit-project.png
|
||||
:align: center
|
||||
|
||||
There you can make changes to the following fields:
|
||||
|
||||
Name
|
||||
The standard dashboard after the plugin installation is called "Project Dashboard". Modify it according to your needs. The name must be unique.
|
||||
|
||||
Description
|
||||
The dashboard description will be displayed in the sidebar next to the dashboard as soon as a dashboard has been been selected to be active.
|
||||
|
||||
Project
|
||||
Here you can select the project this dashboard should be assigned to in case you decide to make it available to special project, only. It is for all projects, if you do not select a project.
|
||||
|
||||
Visible
|
||||
There are various visibility settings for a dashboard like "to me only", "to any users", "to these roles only". If you want to mak a dashboard publicly available to all other users you have to choose the option "to any users". For a specific role choose the respective role instead.
|
||||
|
||||
Enable sidebar
|
||||
The dashboard sidebar contains some useful information for the user. Since it is sometimes disturbing, it is hidden. To prevent this you can select this option.
|
||||
|
||||
System default
|
||||
If you want to make your project dashboard system default, activate this option. So every user will have to work with it for the selected project.
|
||||
|
||||
Always expose
|
||||
If you want to make the system default dashboard name visible to the users in the head section of the dashboard page, you can activate this option. Then also the dashboard information in the sidebar is displayed.
|
||||
|
||||
Author
|
||||
You can change the dashboard author in case it is necessary. This is sometimes necessary, if you create a dasboard for someone else but want this person to be able to edit it afterwards. Or if a user will no longer be active in your Redmine system. *Important:* Only the author of a dashboard is able to edit or remove it (required permissions assumed). If the author is no longer an active user in your system, only a user with administration rights is allowed to modify the dashboard.
|
||||
|
||||
|
||||
.. hint::
|
||||
In general, dashboards can only be edited by a single author. Not by a group. Users with administrator rights can change the author in an emergency.
|
||||
|
||||
.. note::
|
||||
The selection of the Author depends on the set permission for a role in the administration area. Only those user roles with the minimum permission **Save dashboards** or users with administration rights are selectable.
|
||||
|
||||
.. note::
|
||||
Usually the system default "Project dashboard" looks like the standard project page of Redmine. It contains the same areas as "blocks". These can be repositioned or partially hidden. It is up to you if you want to change it. If not, just leave it the way they are.
|
||||
|
||||
|
||||
New project dashboard
|
||||
+++++++++++++++++++++
|
||||
|
||||
Users with appropriate permission can add a new project dashboard by clicking the "New dashboard" link in the "actions menu" to open the "New dashboard" window in order to fill out the following fields. What fields are displayed also depends on the permission the role your user has.
|
||||
|
||||
Name
|
||||
Assign a meaningful and unique name. The dashboard name will be displayed in the sidebar for later selection. If the sidebar has been disabled, you can still select the dashboard from the "Actions" menu. It will then be listed there.
|
||||
|
||||
Description
|
||||
The dashboard description will be displayed in the sidebar next to the dashboard as soon as a dashboard has been been selected to be active.
|
||||
|
||||
Project
|
||||
Select a project for which the new dashboard is planned. If no project is selected here, it will be available to all projects.
|
||||
|
||||
Visible
|
||||
There are various visibility settings for a dashboard like "to me only", "to any users", "to these roles only". If you want to mak a dashboard publicly available to all other users you have to choose the option "to any users". For a specific role choose the respective role instead.
|
||||
|
||||
Enable sidebar
|
||||
The dashboard sidebar contains some useful information for the user. Since it is sometimes disturbing, it is hidden. To prevent this you can choose this option.
|
||||
|
||||
System default
|
||||
If you want to make your project dashboard system default, activate this option. So every user will have to work with it for the selected project.
|
||||
|
||||
Always expose
|
||||
If you want to make the system default dashboard name visible to the users in the head section of the dashboard page, you can activate this option. Then also the dashboard information in the sidebar is displayed.
|
||||
|
||||
|
||||
|
||||
Add project dashboard blocks
|
||||
++++++++++++++++++++++++++++
|
||||
|
||||
You can fill existing project dashboards with content by using the select box "Add block".
|
||||
|
||||
The blocks that are available here depend on the functions you are using and the projects. They need to support the dashboard functionality of the additionals plugin. Which is not hard to do so, because it's easy to implement for plugin developers.
|
||||
|
||||
1. In order to add a new project dashboard block, just select the respective option from the selection box. The block will be added right away.
|
||||
|
||||
.. note::
|
||||
The selection displays only blocks, that are allowed to be displayed on the Redmine project area. Others are not available for selection. Currently the following plugins have additionals dashboard support implemented: DB, Passwords, Reporting, HRM, Automation, additionals
|
||||
|
||||
|
||||
2. You probably need to position the block. In that case hover your mouse over the right block corner and grap the "Move" icon. Now position it somewhere else. If you need to remove it again use the "Delete" icon.
|
||||
|
||||
.. figure:: images/dashboard-actions.png
|
||||
:align: center
|
||||
|
||||
.. note::
|
||||
Be careful with the deletion option. If you delete a block it will be gone right away.
|
||||
|
||||
3. Some blocks can be configured. In that case hover your mouse over the right block corner and click the "Options" icon. The configuration option appears and you can make your changes. Done.
|
||||
|
||||
.. figure:: images/dashboard-options.png
|
||||
:align: center
|
||||
|
||||
.. note::
|
||||
Not every block is configurable and the block configuration may differ depending on the selection you have made. Some blocks may allow to change the column settings and other only the maximum entries, for example.
|
||||
|
||||
|
||||
General dashboard actions
|
||||
-------------------------
|
||||
|
||||
Some actions on the dashboards are the same whether you are on a dashboard of the home page or the project overview page.
|
||||
|
||||
|
||||
Switching dashboards
|
||||
You have two options to switch between existing dashboards. If the sidebar is activated for the dashboard you can select the respective dashboard from the sidebar section. They are grouped by *My dashboards* or *Shared dashboards*.
|
||||
|
||||
|
||||
Enable or disable sidebar
|
||||
If the sidebar is hidden by default you can activate it via the *Actions* menu. Just select the menu option *Enable sidebar*. If the sidebar is displayed but you want to hide it select the menu option *Disable sidebar*.
|
||||
|
||||
|
||||
View sidebar information
|
||||
The sidebar contains always the same information for the user like general globa infos, that are stored there or dashboard specific information regarding the *Active Dashboard* or other dashboards, which are available to you as user.
|
||||
|
||||
|
||||
.. figure:: images/dashboard-sidebar.png
|
||||
:align: center
|
||||
|
||||
Some other general dashboard actions are the selection box in order to
|
||||
|
||||
Add blocks
|
||||
The content which can be added to the active dashboard depends on the functions you are using on your Redmine and the developer of the function. Those need to support the dashboard *Drag & Drop* functionality with their plugin. Regardless of this, the dashboard is always filled with content via the "Add block" selection.
|
||||
|
||||
|
||||
Dashboard blocks
|
||||
----------------
|
||||
|
||||
The following blocks are delivered as standard when using the additionals dashboard function.
|
||||
|
||||
General blocks for all areas (e.g. *Home* and *Project overview*) are:
|
||||
|
||||
Query: Issues
|
||||
You can configure the block content by selecting the *Issue Query* you want to display and choosing a number for *Maximum entries* to be displayed.
|
||||
Maximum number of such blocks per dashboard: **8**
|
||||
|
||||
Long text
|
||||
You can add individual text passages to your dashboard and use the wiki editor for structuring this text. Please note, that some macros are only usable in Wiki pages of a project, but not in issues or dashboard blocks. In that case no content will be displayed, but only the macro code.
|
||||
Maximum number of such blocks per dashboard: **8**
|
||||
|
||||
Latest news
|
||||
Add the latest news block to your dashboard to show your user's what is going on in your system. The block configuration allows you to edit the number of *Maximum entries*.
|
||||
Maximum number of such blocks per dashboard: **1**
|
||||
|
||||
Documents
|
||||
Add the *Documents* block to your dashboard to show your user's the latest documents, uploaded in Redmine. The block configuration allows you to edit the number of *Maximum entries*.
|
||||
Maximum number of such blocks per dashboard: **1**
|
||||
|
||||
Static spent time
|
||||
Add the *Spent time* block to your dashboard to show the spent time activities. The block configuration allows you to edit the number of *Days* displayed in the block.
|
||||
Maximum number of such blocks per dashboard: **1**
|
||||
|
||||
Atom+RSS Feed
|
||||
You can configure the block content by changing the *Title*, adding an *URL* and choosing a number for *Maximum entries* to be displayed.
|
||||
Maximum number of such blocks per dashboard: **8**
|
||||
|
||||
|
||||
Special blocks for the welcome page *Home* are:
|
||||
|
||||
Standard content left / Standard content right
|
||||
There are plugin developers who do not support our dashboard function and may have implement own content on the Redmine start page (legacy_left and legacy_right). These are usually not displayed due to the lack of dashboard support. If you still want to see this, select one of the two blocks or both for displaying such content.
|
||||
|
||||
Activity
|
||||
You can configure the activity block content by choosing a number for *Maximum entries* to be displayed. And in case you are only interested in your own activities by activating the option *Only my activity*. Maximum number of such blocks per dashboard: **1**
|
||||
|
||||
Welcome
|
||||
If you have specified a welcome text in the Redmine system settings you can display this text in the dashboard as well, by choosing the *Welcome* block. Maximum number of such blocks per dashboard: **1**
|
||||
|
||||
|
||||
Special blocks for *Project overview* are:
|
||||
|
||||
Standard content left / Standard content right
|
||||
There are plugin developers who do not support our dashboard function and may have implement own content on the Redmine project overview page (legacy_left and legacy_right). These are usually not displayed due to the lack of dashboard support. If you still want to see this, select one of the two blocks or both for displaying such content as well.
|
||||
|
||||
Project information
|
||||
Displays the standard project information of Redmine in a block. Containing the project information from the project settings like custom fields for projects, description, URL etc. The block is not configurable, but you can remove it if not needed or reposition it.
|
||||
|
||||
Subprojects
|
||||
Displays the standard subproject information of Redmine in a block, if you have configured them in the project settings. The block is not configurable, but you can remove it if not needed or reposition it.
|
||||
|
||||
Issue tracking
|
||||
Displays the standard issue tracking information of Redmine in a block. The block is not configurable, but you can remove it if not needed or reposition it.
|
||||
|
||||
Time tracking
|
||||
Displays the standard issue tracking information of Redmine in a block including the additionals adaption to the information displayed there. The block is not configurable, but you can remove it if not needed or reposition it.
|
||||
|
||||
Members
|
||||
Displays the standard member box of Redmine in a block including the additionals permission adaption to the information displayed there. The block is not configurable, but you can remove it if not needed or reposition it.
|
||||
|
||||
.. note::
|
||||
These are the basic blocks that come with the additionals plugin dashboard functionality. Other plugins, that also support the *Drag&Drop* dashboard function may deliver additional blocks for selection.
|
||||
|
||||
.. note::
|
||||
Notes about caching: All blocks are cached asynchron (every 30 seconds). The RSS Feed blocks are cached asynchron (every 10 minutes). The time tracking block is chached asynchron (every 1 hour).
|
||||
BIN
plugins/additionals/docs/images/dashboard-actions.png
Normal file
BIN
plugins/additionals/docs/images/dashboard-actions.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.8 KiB |
BIN
plugins/additionals/docs/images/dashboard-add-block.png
Normal file
BIN
plugins/additionals/docs/images/dashboard-add-block.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 64 KiB |
BIN
plugins/additionals/docs/images/dashboard-edit-project.png
Normal file
BIN
plugins/additionals/docs/images/dashboard-edit-project.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 36 KiB |
BIN
plugins/additionals/docs/images/dashboard-edit.png
Normal file
BIN
plugins/additionals/docs/images/dashboard-edit.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
BIN
plugins/additionals/docs/images/dashboard-home.png
Normal file
BIN
plugins/additionals/docs/images/dashboard-home.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
BIN
plugins/additionals/docs/images/dashboard-options.png
Normal file
BIN
plugins/additionals/docs/images/dashboard-options.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
BIN
plugins/additionals/docs/images/dashboard-overview.png
Normal file
BIN
plugins/additionals/docs/images/dashboard-overview.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 119 KiB |
BIN
plugins/additionals/docs/images/dashboard-projectoverview.png
Normal file
BIN
plugins/additionals/docs/images/dashboard-projectoverview.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 59 KiB |
BIN
plugins/additionals/docs/images/dashboard-sidebar.png
Normal file
BIN
plugins/additionals/docs/images/dashboard-sidebar.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 205 KiB |
|
|
@ -12,8 +12,6 @@ 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
|
||||
|
|
@ -23,13 +21,12 @@ This plugin is the successor of `Redmine Tweaks <https://github.com/alphanodes/r
|
|||
: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://github.com/AlphaNodes/additionals/workflows/Run%20Linters/badge.svg
|
||||
:target: https://github.com/AlphaNodes/additionals/actions?query=workflow%3A%22Run+Linters%22
|
||||
|
||||
.. 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
|
||||
|
|
@ -38,9 +35,9 @@ Requirements
|
|||
------------
|
||||
|
||||
+--------------------+----------------------+
|
||||
| `Redmine`_ version | >= 3.4.0 |
|
||||
| `Redmine`_ version | >= 4.1.0 |
|
||||
+--------------------+----------------------+
|
||||
| `Ruby`_ version | >= 2.3.0 |
|
||||
| `Ruby`_ version | >= 2.4.0 |
|
||||
+--------------------+----------------------+
|
||||
| Gem packages | see `Gemfile`_ |
|
||||
+--------------------+----------------------+
|
||||
|
|
@ -54,7 +51,7 @@ Install ``additionals`` plugin for `Redmine`_.
|
|||
.. code-block:: bash
|
||||
|
||||
$ cd $REDMINE_ROOT
|
||||
$ git clone -b v2-stable git://github.com/alphanodes/additionals.git plugins/additionals
|
||||
$ git clone -b v3-stable https://github.com/AlphaNodes/additionals.git plugins/additionals
|
||||
$ bundle install --without development test
|
||||
$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
|
||||
$
|
||||
|
|
@ -102,18 +99,21 @@ Uninstall ``additionals`` plugin for `Redmine`_.
|
|||
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:
|
||||
* Dashboard (Drag&Drop) Support
|
||||
* Text for login page
|
||||
* Global footer for all projects
|
||||
* Welcome text for login page
|
||||
* Global sidebar content support
|
||||
* Note for new issues above issue content (e.g. for guidelines)
|
||||
* PDF for wiki pages
|
||||
* Wiki macros for:
|
||||
|
||||
* asciinema
|
||||
* cryptocompare
|
||||
* date
|
||||
* fa
|
||||
* gihub gist
|
||||
* google_docs
|
||||
* gmap
|
||||
* group_users
|
||||
* iframe
|
||||
|
|
@ -149,7 +149,6 @@ Features
|
|||
* 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
|
||||
|
||||
|
|
@ -167,13 +166,15 @@ Don't worry, if you only need a subset of the provided libraries. If you do not
|
|||
|
||||
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>`_
|
||||
* `Chart.js 2.9.3 <https://www.chartjs.org/>`_
|
||||
* `Chart.js Plugin colorschemes 0.4.0 <https://github.com/nagix/chartjs-plugin-colorschemes>`_
|
||||
* `Chart.js Plugin datalabels 0.7.0 <https://github.com/chartjs/chartjs-plugin-datalabels>`_
|
||||
* `clipboardJS 2.0.6 <https://clipboardjs.com/>`_
|
||||
* `d3 6.1.1 <https://d3js.org/>`_
|
||||
* `d3plus v2.0.0-alpha.29 <https://d3plus.org/>`_
|
||||
* `FontAwesome 5.14.0 <https://fontawesome.com/>`_
|
||||
* `mermaid 8.8.0 <https://github.com/knsv/mermaid/>`_
|
||||
* `Select2 4.0.13 <https://select2.org/>`_
|
||||
|
||||
And a set of various Rails helper methods (see below).
|
||||
|
||||
|
|
@ -191,17 +192,35 @@ This method loads all JS and CSS files needed by the required module.
|
|||
|
||||
The following modules are available :
|
||||
|
||||
* chartjs
|
||||
* chartjs_colorschemes
|
||||
* chartjs_datalabels
|
||||
* clipboardjs
|
||||
* d3
|
||||
* d3plus
|
||||
* mermaid
|
||||
* nvd3
|
||||
* font_awesome
|
||||
* notify
|
||||
* zeroclipboard
|
||||
* mermaid
|
||||
* select2
|
||||
|
||||
Redmine Plugins, which are using ``additionals``
|
||||
------------------------------------------------
|
||||
|
||||
* `redmine_automation <https://alphanodes.com/redmine-automation>`_
|
||||
* `redmine_codimd <https://github.com/AlphaNodes/redmine_codimd>`_
|
||||
* `redmine_db <https://alphanodes.com/redmine-db>`_
|
||||
* `redmine_git_hosting <http://redmine-git-hosting.io/>`_
|
||||
* `redmine_hrm <https://alphanodes.com/redmine-hrm>`_
|
||||
* `redmine_omniauth_saml <https://github.com/alexandermeindl/redmine_omniauth_saml>`_
|
||||
* `redmine_passwords <https://alphanodes.com/redmine-passwords>`_
|
||||
* `redmine_postgresql_search <https://github.com/AlphaNodes/redmine_postgresql_search>`_
|
||||
* `redmine_privacy_terms <https://github.com/AlphaNodes/redmine_privacy_terms>`_
|
||||
* `redmine_reporting <https://alphanodes.com/redmine-reporting>`_
|
||||
* `redmine_sudo <https://github.com/AlphaNodes/redmine_sudo>`_
|
||||
|
||||
If you know other plugins, which are using ``additionals``, please let us know or create a `PR <https://github.com/alphanodes/additionals/pulls>`_.
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -210,6 +229,7 @@ I am glad about your feedback on the plugin, `pull requests <https://github.com/
|
|||
:maxdepth: 2
|
||||
|
||||
manual
|
||||
dashboards
|
||||
macros
|
||||
tasks
|
||||
new_feature
|
||||
|
|
|
|||
|
|
@ -5,12 +5,13 @@ These wiki macros are available with Additionals.
|
|||
|
||||
If a parameter is in brackets, this parameter is optional.
|
||||
|
||||
.. include:: macros/calendar.rst
|
||||
.. include:: macros/asciinema.rst
|
||||
.. include:: macros/cryptocompare.rst
|
||||
.. include:: macros/date.rst
|
||||
.. include:: macros/fa.rst
|
||||
.. include:: macros/gist.rst
|
||||
.. include:: macros/gmap.rst
|
||||
.. include:: macros/google_docs.rst
|
||||
.. include:: macros/group_users.rst
|
||||
.. include:: macros/iframe.rst
|
||||
.. include:: macros/issue.rst
|
||||
|
|
|
|||
26
plugins/additionals/docs/macros/asciinema.rst
Normal file
26
plugins/additionals/docs/macros/asciinema.rst
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
Asciinema
|
||||
---------
|
||||
|
||||
Graphical application developers often use screencasts to demonstrate functions of their programs. With Asciinema you have the possibility to record such videos, but are restricted completely to the terminal. So you can record and publish actions in the shell. With the additionals plugin macro for Asciinema you can implement such videos into Redmine.
|
||||
|
||||
asciinema.org wiki macro for Redmine.
|
||||
|
||||
.. function:: {{asciinema(cast_id)}}
|
||||
|
||||
show asciinema.org cast
|
||||
|
||||
:param string cast_id: asciinema.org asciicast id
|
||||
|
||||
Scope
|
||||
+++++
|
||||
|
||||
This macro works in all text fields with formatting support.
|
||||
|
||||
Examples
|
||||
++++++++
|
||||
|
||||
show asciinema.org cast_id ``113463``
|
||||
|
||||
.. code-block:: smarty
|
||||
|
||||
{{asciinema(113463)}}
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
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)}}
|
||||
|
|
@ -1,6 +1,8 @@
|
|||
CryptoCompare
|
||||
-------------
|
||||
|
||||
CryptoCompare is an Internet plattform where you can interactively inform yourself about the latest trends in crypto currencies and follow the development of the crypto market in real-time.
|
||||
|
||||
CryptoCompare wiki macro for Redmine.
|
||||
|
||||
See https://www.cryptocompare.com/dev/widget/wizard/ for more information.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
Gist
|
||||
----
|
||||
|
||||
Github gist wiki macro for Redmine.
|
||||
GitHub, a service for hosting larger projects, also operates other services like Gist. Gist is for hosting code snippets. If you are using the additionals plugin for your Redmine, you can implement your Github Gist by using the following wiki macro.
|
||||
|
||||
.. function:: {{gist(gist)}}
|
||||
|
||||
|
|
|
|||
33
plugins/additionals/docs/macros/google_docs.rst
Normal file
33
plugins/additionals/docs/macros/google_docs.rst
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
Google Docs
|
||||
-----------
|
||||
|
||||
Google Docs wiki macro for Redmine. Google Docs is an online word processor that you can use to create, format, and collaborate on documents. The macro helps you to integrat a Google Docs document as iframe into a Redmine text field.
|
||||
|
||||
.. function:: {{google_docs(link[, width=WIDTH, height=HEIGHT, edit_link=URL])}}
|
||||
|
||||
Show Google Docs embedded
|
||||
|
||||
:param string link: Embedded Google docs link
|
||||
:param int width: width (if not specified, 100% is used)
|
||||
:param int height: height (if not specified, 485 is used)
|
||||
:param int edit_link: Link to edit page
|
||||
|
||||
Scope
|
||||
+++++
|
||||
|
||||
This macro works in all text fields with formatting support (e.g. Redmine Wiki).
|
||||
|
||||
Examples
|
||||
++++++++
|
||||
|
||||
Google docs ``https://docs.google.com/spreadsheets/d/e/2PACX-1vQL__Vgu0Y0f-P__GJ9kpUmQ0S-HG56ni_b-x4WpWxzGIGXh3X6A587SeqvJDpH42rDmWVZoUN07VGE/pubhtml`` (iframe) and default size 100% x 485
|
||||
|
||||
.. code-block:: smarty
|
||||
|
||||
{{google_docs(https://docs.google.com/spreadsheets/d/e/2PACX-1vQL__Vgu0Y0f-P__GJ9kpUmQ0S-HG56ni_b-x4WpWxzGIGXh3X6A587SeqvJDpH42rDmWVZoUN07VGE/pubhtml)}}
|
||||
|
||||
Google docs with size 1200 x 1000
|
||||
|
||||
.. code-block:: smarty
|
||||
|
||||
{{slideshare(https://docs.google.com/spreadsheets/d/e/2PACX-1vQL__Vgu0Y0f-P__GJ9kpUmQ0S-HG56ni_b-x4WpWxzGIGXh3X6A587SeqvJDpH42rDmWVZoUN07VGE/pubhtml, width=1200, height=1000)}}
|
||||
|
|
@ -1,7 +1,9 @@
|
|||
Iframe
|
||||
------
|
||||
|
||||
Iframe macro for Redmine.
|
||||
Iframe macro for Redmine. The iframe is a square HTML element. It can be embedded e.g. within a Wiki page of Redmine. Via an iframe, content from other Internet pages can be integrated just like via a small integrated browser window.
|
||||
|
||||
For example you can integrate a CodiMD Pad page into your Wiki pages.
|
||||
|
||||
.. function:: {{iframe(url [, width=INT, height=INT, with_link=BOOL])}}
|
||||
|
||||
|
|
|
|||
|
|
@ -3,13 +3,14 @@ Members, Project
|
|||
|
||||
Project members macro for Redmine.
|
||||
|
||||
.. function:: {{members([project_name, title=TITLE, role=ROLE])}}
|
||||
.. function:: {{members([project_name, title=TITLE, role=ROLE, with_sum=BOOL])}}
|
||||
|
||||
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.
|
||||
:param bool with_sum: show amount of members.
|
||||
|
||||
Scope
|
||||
+++++
|
||||
|
|
@ -25,6 +26,12 @@ List all members for all projects (with the current user permission)
|
|||
|
||||
{{members}}
|
||||
|
||||
List all members for all projects and show amount of members
|
||||
|
||||
.. code-block:: smarty
|
||||
|
||||
{{members(with_sum=true)}}
|
||||
|
||||
List all members for the project with the identifier of ``myproject``
|
||||
|
||||
.. code-block:: smarty
|
||||
|
|
|
|||
|
|
@ -1,6 +1,8 @@
|
|||
Reddit
|
||||
------
|
||||
|
||||
Reddit is an English-language website for social media news, web content rating and discussions. As a registered member, you can submit content, links or images and present them to other members. Link to your Reddit account or other content within Redmine by using the additionals plugin macro.
|
||||
|
||||
Reddit wiki macro for Redmine.
|
||||
|
||||
.. function:: {{reddit(name)}}
|
||||
|
|
|
|||
|
|
@ -1,6 +1,11 @@
|
|||
Manual
|
||||
======
|
||||
|
||||
The plugin configuration takes place in the administration area by a user with administration permission. Go to *Plugins / Additionals* to open it.
|
||||
|
||||
The additionals plugin configuration is divided into several sections, which are described here.
|
||||
|
||||
|
||||
General section
|
||||
---------------
|
||||
|
||||
|
|
@ -12,48 +17,31 @@ 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.
|
||||
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**:
|
||||
|
||||
* Activate the option ``Open external URLs`` in order to open those URLs in a new window or browser tab if someone wants to visit them.
|
||||
* 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.
|
||||
* Activate the ``Legacy smileys support`` if you want to use the manual smiley code in your text (e.g. ``:)``). If you already use a plugin that supports Smileys 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.
|
||||
* ``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:: 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:: Please restart the application server, if you make changes to the external urls settings as well as if you activate the Smileys 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
|
||||
------------
|
||||
|
||||
|
|
@ -70,8 +58,8 @@ 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)
|
||||
You can also implement useful macros in this section.
|
||||
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.
|
||||
|
|
@ -84,15 +72,20 @@ 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 Wiki title from PDF view When activated the general Wiki title info in the page header of the PDF view 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
|
||||
-------------
|
||||
Macros 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.
|
||||
Redmine itself and Redmine plugins are sometimes equipped with additional macros for usage. Macros can be used in the Wiki of a project or in the text area of an issue. For more information on how to add macros use the Redmine help documentation.
|
||||
|
||||
The *Macros section* of the additionals plugin 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 to your users 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
|
||||
|
|
@ -100,39 +93,67 @@ This section lists all available macros that the logged in user can use with the
|
|||
|
||||
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.
|
||||
.. 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 with no macro experience to make it easier for them to use macros or to remember them.
|
||||
|
||||
|
||||
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 the 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.
|
||||
|
||||
|
||||
|
||||
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.
|
||||
Here you can define issue rules, which are used in issues of all projects.
|
||||
|
||||
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 (edit mode). Keep it short and use a link to a common wiki page with further information.
|
||||
|
||||
* 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. And make sure the wiki page you link to is accessible for every user.
|
||||
|
||||
.. note:: You can use wiki syntax for your text, but use it wisely.
|
||||
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.
|
||||
|
||||
Settings
|
||||
++++++++
|
||||
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.
|
||||
|
||||
The following options are available at the moment in the area **Settings** where you can define rules which will be used in all projects:
|
||||
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.
|
||||
|
||||
* 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 options above only work for users with appropriate issue tracking rights in the administration area "Roles and permissions" (view, create, edit).
|
||||
|
||||
.. 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.
|
||||
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.
|
||||
|
||||
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.
|
||||
Issues should be automatically assigned to the author, if the status changes to "Approval".
|
||||
|
||||
.. figure:: images/account-preferences.jpg
|
||||
:align: center
|
||||
|
|
@ -141,31 +162,22 @@ The following options are available at the moment in the area **Settings** where
|
|||
|
||||
.. 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.
|
||||
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.
|
||||
|
||||
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.
|
||||
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
|
||||
------------
|
||||
|
||||
|
|
@ -196,7 +208,7 @@ In the **Settings** area of the menu tab there are the following functions avail
|
|||
* 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.
|
||||
|
|
@ -205,6 +217,7 @@ In order to activate the checkbox ``SPAM protection for registration`` you must
|
|||
|
||||
.. 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
|
||||
----------------
|
||||
|
||||
|
|
@ -233,63 +246,50 @@ The following menu items are currently implemented if a plugin is installed, tha
|
|||
Known external plugins that have a user manual and support this feature are currently:
|
||||
|
||||
* additionals
|
||||
* redmine_automation
|
||||
* redmine_privacy_terms
|
||||
* redmine_db
|
||||
* redmine_passwords
|
||||
* redmine_hrm
|
||||
* redmine_reporting
|
||||
|
||||
|
||||
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
|
||||
----------------------
|
||||
Additionals 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.
|
||||
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.
|
||||
Show hidden roles
|
||||
Section Project. In case you have hidden roles in a project that should not be displayed in the member box for example 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 even if he or she is user of another project with different roles.
|
||||
|
||||
* **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.
|
||||
Save dashboards
|
||||
Section Project. Allow this user role to add, edit or delete dashboards of their own. So this users can add dashboards for every purpose they want and switch between them.
|
||||
|
||||
* **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 system dashboards
|
||||
Section Project. This permission requires *Save dashboards* permission. If you activate it, you allow users with this permission to change the system wide dashboard. Those user may create dashboards and make them system default. They get additional options: *Visible*, *System default* and *Always expose*.
|
||||
|
||||
* **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.
|
||||
Share dashboards
|
||||
Section Project. Allow user roles with this permission to share dashboards with other users. This means if someone else assigns you a dashboard via *Author* selection, you are allowed to edit those dashboards as long as you are the assigned *Author* and also have the permission to *Save dashboards*.
|
||||
|
||||
* **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.
|
||||
Edit issue author
|
||||
Section Issue tracking. This permission will always record any changes made to the issue author. You can change the author only in the issue edit mode. This function replaces the use of external plugins (e.g. change_author)
|
||||
|
||||
Edit closed issues
|
||||
Section Issue tracking. Set this option to those roles you do not want to edit closed issues. Normally a closed issue should not be edited anymore.
|
||||
|
||||
Set author of new issues
|
||||
Section Issue tracking. 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
|
||||
Section Time tracking. 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.
|
||||
|
|
|
|||
|
|
@ -51,11 +51,11 @@ Set default modules for new projects
|
|||
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
|
||||
Set plugin setting ``open_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"
|
||||
bundle exec rake redmine:additionals:setting_set RAILS_ENV=production name="additionals" setting="open_external_urls" value="1"
|
||||
|
||||
|
||||
setting_get
|
||||
|
|
@ -71,11 +71,11 @@ setting_get
|
|||
Examples
|
||||
++++++++
|
||||
|
||||
Get setting for ``external_urls`` of the plugin additionals
|
||||
Get setting for ``open_external_urls`` of the plugin additionals
|
||||
|
||||
.. code-block:: smarty
|
||||
|
||||
bundle exec rake redmine:additionals:setting_get RAILS_ENV=production name="additionals" setting="external_urls"
|
||||
bundle exec rake redmine:additionals:setting_get RAILS_ENV=production name="additionals" setting="open_external_urls"
|
||||
|
||||
Get ``app_title`` of redmine
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue