Actualiza el plugin Additionals a 3.0.2-master
This commit is contained in:
parent
3b6a41320c
commit
cfa0d58b18
164 changed files with 2027 additions and 58190 deletions
|
|
@ -322,8 +322,12 @@ 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.
|
||||
Text
|
||||
You can add individual text passages to your dashboard and use the wiki editor for structuring this text. If you want to work with macros, that include large amount of information (e.g. issue lists), use the *Text (asynchronous)* block instead, because it is cached asyncronous for 30 seconds due to performance reasons.
|
||||
Maximum number of such blocks per dashboard: **8**
|
||||
|
||||
Text (asynchronous)
|
||||
This block is perfect if you want to implement macros into your text area. 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
|
||||
|
|
@ -380,3 +384,76 @@ Members
|
|||
|
||||
.. 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).
|
||||
|
||||
|
||||
Default Dashboards
|
||||
------------------
|
||||
|
||||
When installing the Additionals plugin it comes with default dashboards for the Redmine *Home* page as well as the Redmine *Project overview* page. The typical default dashboard has the following key options:
|
||||
|
||||
* Visible: *to any users*
|
||||
* Marked as *System default*
|
||||
|
||||
In case you want to restore the default dashboard you can simply add a new one or arrange an existing one by using the following blocks and position them in the left or right area.
|
||||
|
||||
Default Dashboard blocks: Home
|
||||
Welcome (left), Standard content left (left), Standard content right (right)
|
||||
|
||||
|
||||
Default Dashboard blocks: Project overview
|
||||
Project information (left), Issue tracking (left), Time tracking (left), Members (right), Sub projects (right)
|
||||
|
||||
|
||||
|
||||
Dashboard FAQ
|
||||
-------------
|
||||
|
||||
Is there a restore function?
|
||||
No, there is no restore function for your default dashboard. If you add dashboard blocks you don't like, just remove them and add other ones.
|
||||
|
||||
I messed up my default Dashboard
|
||||
There is nothing bad about it. Just remove the dashboard blocks you don't like and start over. The best way to start a new default dashboard anyway is to create a new dashboard, first and add the blocks you like. If everything is the way you want it, make it "Default". Keep the old "Default" as backup.
|
||||
|
||||
I accidently deleted a Dashboard block
|
||||
This will always happen, if you work as user with the appropriate permission to do so (e.g. administration permissions). We recommend not do work with those permission in your regular work day. Create your dashboards one time and switch user permissions afterwards. So this will not happen again.
|
||||
|
||||
How many default Dashboards can be created?
|
||||
There is just one system default dashboard possible for every area. This means one default dashboard for the Redmine "Home" page. And one for the general project overview page. But you can create also one default for a specific project overview page, which will than be "Project default".
|
||||
|
||||
Does every user sees the content of every Dashboard block?
|
||||
You do not control the content a user in your project sees via the dashboard block you add, but still by setting up the correct user permissions in the administration area "Roles and permissions". Those permissions for a user role are relevant for the content a user can view in your project and must be set correctly.
|
||||
|
||||
Developer Information
|
||||
---------------------
|
||||
|
||||
You are a plugin developer and want to support Dashboards for your plugin as well? Great! Thank you for that.
|
||||
Learn how to implement Dashboard blocks in your plugins. There are only two things required for that:
|
||||
|
||||
Create block template
|
||||
Create a template for your block in *app/views/dashboards/blocks/*. The name of your template should be unique, that there are no conflicts with other blocks (e.g. from other plugins)
|
||||
|
||||
.. note::
|
||||
Examples: Go to https://github.com/AlphaNodes/additionals/tree/master/app/views/dashboards/blocks for examples.
|
||||
|
||||
Add block definitions
|
||||
Add your block definition in *block_definitions*. This could be in:
|
||||
|
||||
* dashboard_content.rb (if your block should be available in all dashboards)
|
||||
* dashboard_content_project.rb (if your block should be available in project dashboards only)
|
||||
* dashboard_content_welcome.rb (if your block should be available in welcome dashboards only)
|
||||
|
||||
.. note::
|
||||
Examples: Go to https://github.com/AlphaNodes/additionals/blob/master/app/models/dashboard_content.rb#L29 for examples for that.
|
||||
|
||||
Overwrite it with *prepend* (not alias_method) to get no conflicts with other plugins. See *redmine_git_hosting* [#githosting]_ for an example implementation for a *block template* [#blocktemplate]_ and a *block definition* [#blockdefinition]_
|
||||
|
||||
That's it. As you can see, it's not so hard.
|
||||
In case of further questions use the issue tracking system for this project on GitHub.
|
||||
|
||||
.. rubric:: Footnotes
|
||||
|
||||
.. [#githosting] https://github.com/jbox-web/redmine_git_hosting
|
||||
|
||||
.. [#blocktemplate] https://github.com/jbox-web/redmine_git_hosting/blob/master/app/views/dashboards/blocks/_git_urls.html.slim
|
||||
|
||||
.. [#blockdefinition] https://github.com/jbox-web/redmine_git_hosting/blob/master/lib/redmine_git_hosting/patches/dashboard_content_project_patch.rb
|
||||
|
|
|
|||
|
|
@ -21,8 +21,8 @@ Additionals is a `Redmine`_ plugin for customizing Redmine, providing wiki macro
|
|||
:target: https://additionals.readthedocs.io/en/latest/?badge=latest
|
||||
:alt: Documentation Status
|
||||
|
||||
.. image:: https://travis-ci.org/AlphaNodes/additionals.svg?branch=master
|
||||
:target: https://travis-ci.org/AlphaNodes/additionals
|
||||
.. image:: https://github.com/AlphaNodes/additionals/workflows/Tests/badge.svg
|
||||
:target: https://github.com/AlphaNodes/additionals/actions?query=workflow%3ATests
|
||||
|
||||
.. image:: https://github.com/AlphaNodes/additionals/workflows/Run%20Linters/badge.svg
|
||||
:target: https://github.com/AlphaNodes/additionals/actions?query=workflow%3A%22Run+Linters%22
|
||||
|
|
@ -34,13 +34,17 @@ Additionals is a `Redmine`_ plugin for customizing Redmine, providing wiki macro
|
|||
Requirements
|
||||
------------
|
||||
|
||||
+--------------------+----------------------+
|
||||
| `Redmine`_ version | >= 4.1.0 |
|
||||
+--------------------+----------------------+
|
||||
| `Ruby`_ version | >= 2.4.0 |
|
||||
+--------------------+----------------------+
|
||||
| Gem packages | see `Gemfile`_ |
|
||||
+--------------------+----------------------+
|
||||
+--------------------+-----------------------------------+
|
||||
| `Redmine`_ version | >= 4.1.0 |
|
||||
+--------------------+-----------------------------------+
|
||||
| `Ruby`_ version | >= 2.4.0 |
|
||||
+--------------------+-----------------------------------+
|
||||
| Database version | MySQL >= 5.7 or PostgreSQL >= 9.6 |
|
||||
+--------------------+-----------------------------------+
|
||||
|
||||
.. note:: If you use MySQL, make sure all database tables using the same storage engine (InnoDB is recommended) and character set (utf8mb4 is recommended).
|
||||
|
||||
.. note:: For more information use the official `Redmine install documentation <https://www.redmine.org/projects/redmine/wiki/RedmineInstall>`_
|
||||
|
||||
|
||||
Installation
|
||||
|
|
@ -51,7 +55,7 @@ Install ``additionals`` plugin for `Redmine`_.
|
|||
.. code-block:: bash
|
||||
|
||||
$ cd $REDMINE_ROOT
|
||||
$ git clone -b v3-stable https://github.com/AlphaNodes/additionals.git plugins/additionals
|
||||
$ git clone -b stable https://github.com/AlphaNodes/additionals.git plugins/additionals
|
||||
$ bundle install --without development test
|
||||
$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
|
||||
$
|
||||
|
|
@ -118,10 +122,13 @@ Features
|
|||
* group_users
|
||||
* iframe
|
||||
* issues
|
||||
* last_updated_at
|
||||
* last_updated_by
|
||||
* members
|
||||
* meteoblue
|
||||
* new_issue
|
||||
* projects
|
||||
* recently_updated
|
||||
* reddit
|
||||
* redmine.org issue and wiki page (redmine_issue and reminde_wiki)
|
||||
* slideshare
|
||||
|
|
@ -141,7 +148,6 @@ Features
|
|||
* 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
|
||||
|
|
@ -166,14 +172,14 @@ Don't worry, if you only need a subset of the provided libraries. If you do not
|
|||
|
||||
It provides :
|
||||
|
||||
* `Chart.js 2.9.3 <https://www.chartjs.org/>`_
|
||||
* `Chart.js 2.9.4 <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/>`_
|
||||
* `clipboardJS 2.0.8 <https://clipboardjs.com/>`_
|
||||
* `d3 6.6.0 <https://d3js.org/>`_
|
||||
* `d3plus v2.0.0-alpha.30 <https://d3plus.org/>`_
|
||||
* `FontAwesome 5.15.2 <https://fontawesome.com/>`_
|
||||
* `mermaid 8.9.1 <https://github.com/knsv/mermaid/>`_
|
||||
* `Select2 4.0.13 <https://select2.org/>`_
|
||||
|
||||
And a set of various Rails helper methods (see below).
|
||||
|
|
@ -205,10 +211,11 @@ The following modules are available :
|
|||
Redmine Plugins, which are using ``additionals``
|
||||
------------------------------------------------
|
||||
|
||||
* `additional_tags <https://github.com/AlphaNodes/additional_tags>`_
|
||||
* `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_hedgedoc <https://github.com/AlphaNodes/redmine_hedgedoc>`_
|
||||
* `redmine_hrm <https://alphanodes.com/redmine-hrm>`_
|
||||
* `redmine_omniauth_saml <https://github.com/alexandermeindl/redmine_omniauth_saml>`_
|
||||
* `redmine_passwords <https://alphanodes.com/redmine-passwords>`_
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ Iframe
|
|||
|
||||
Iframe macro for Redmine. The iframe is a square HTML element. It can be embedded e.g. within a Wiki page of Redmine. Via an iframe, content from other Internet pages can be integrated just like via a small integrated browser window.
|
||||
|
||||
For example you can integrate a CodiMD Pad page into your Wiki pages.
|
||||
For example you can integrate a HedgeDoc Pad page into your Wiki pages.
|
||||
|
||||
.. function:: {{iframe(url [, width=INT, height=INT, with_link=BOOL])}}
|
||||
|
||||
|
|
|
|||
|
|
@ -3,13 +3,14 @@ User
|
|||
|
||||
User wiki macro for Redmine.
|
||||
|
||||
.. function:: {{user_name [, format=FORMAT, avatar=BOOL])}}
|
||||
.. function:: {{user(user [, format=FORMAT, text=BOOL, avatar=BOOL])}}
|
||||
|
||||
Display link to user profile
|
||||
|
||||
:param string user_name: username (login name) or user id of the user
|
||||
:param string user: user name (login name) or user id of the user. If current user is used as login name the currently logged in user will be used.
|
||||
: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
|
||||
:param bool text: show text only (without link), if true (default: false)
|
||||
:param bool avatar: show avatar, if true (default: false)
|
||||
|
||||
Scope
|
||||
+++++
|
||||
|
|
@ -60,3 +61,15 @@ Link to user profile with login name ``admin`` with first name and last name as
|
|||
.. code-block:: smarty
|
||||
|
||||
{{user(admin, format=firstname_lastname)}}
|
||||
|
||||
Display name of currently logged in user with username as text
|
||||
|
||||
.. code-block:: smarty
|
||||
|
||||
{{user(current_user, text=true)}}
|
||||
|
||||
Display name of currently logged in user with username
|
||||
|
||||
.. code-block:: smarty
|
||||
|
||||
{{user(current_user)}}
|
||||
|
|
|
|||
|
|
@ -32,15 +32,26 @@ 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.
|
||||
* 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.
|
||||
Open external URLs
|
||||
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.
|
||||
|
||||
Go to top Link
|
||||
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.
|
||||
|
||||
Legacy smileys support
|
||||
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 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 @}->-
|
||||
|
||||
|
||||
.. note:: You can use the following manual smiley codes: :), =), :D, =D, :'(, :(, ;), :P, :O, :/, :S, :|, :X, :*, O:), >:), B), (!), (?), (v), (x), (/) and @}->-
|
||||
|
||||
Wiki section
|
||||
------------
|
||||
|
|
@ -207,16 +218,6 @@ In the **Settings** area of the menu tab there are the following functions avail
|
|||
* 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
|
||||
----------------
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue