From 848f16aa4b4fa5a4c04d81af4d1a15997838d2f1 Mon Sep 17 00:00:00 2001 From: Alexander Meindl Date: Thu, 28 Apr 2022 12:20:19 +0200 Subject: [PATCH] Start migration from readthedocs to README.md --- CHANGELOG.rst => CHANGELOG.md | 180 +++++++++++------------------- MACROS.md | 35 ++++++ README.md | 200 ++++++++++++++++++++++++++++++++++ README.rst | 1 - 4 files changed, 296 insertions(+), 120 deletions(-) rename CHANGELOG.rst => CHANGELOG.md (93%) create mode 100644 MACROS.md create mode 100644 README.md delete mode 120000 README.rst diff --git a/CHANGELOG.rst b/CHANGELOG.md similarity index 93% rename from CHANGELOG.rst rename to CHANGELOG.md index 02183b95..afe3c7c8 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.md @@ -1,8 +1,6 @@ -Changelog -========= +# Changelog -3.0.6 -+++++ +## 3.0.6 - D3 7.4.4 support - Remove issue autowatch (this feature comes with Redmine 5) @@ -15,18 +13,15 @@ Changelog - Add Chart.js matrix plugin - Fix scope of users for select2 in projects -3.0.5.2 -+++++++ +## 3.0.5.2 - Fix refresh bug for async blocks for query lists -3.0.5.1 -+++++++ +## 3.0.5.1 - Fix refresh bug for async blocks if settings change -3.0.5 -+++++ +## 3.0.5 - Mermaid 8.14.0 support - D3 7.3.0 support @@ -36,8 +31,7 @@ Changelog - introduce hooks controller_additionals_change_status_before_save, controller_additionals_change_status_after_save (see #127) - Fix multiple asynchronous block loads -3.0.4 -+++++ +## 3.0.4 - Mermaid 8.13.6 support - D3 7.2.1 support @@ -47,8 +41,7 @@ Changelog - fixed default dashboard order for system default for specific project - add rake task "redmine:additionals:reset_recently_dashboards" to reset recently used dashboards -3.0.3 -+++++ +## 3.0.3 - Ruby 2.7 warnings fixed - Mermaid 8.11.5 support @@ -57,10 +50,9 @@ Changelog - new ticket message can be overwritten for projects - fixed scope of public project dashboards for all projects - FontAwesome 5.15.4 support -- Adjust integration of macro button, because of changed Redmine source (https://www.redmine.org/issues/31887) +- Adjust integration of macro button, because of changed Redmine source -3.0.2 -+++++ +## 3.0.2 - d3plus to v2.0.0-alpha.30 support - Mermaid 8.9.2 support @@ -72,8 +64,7 @@ Changelog - clipboard.js updated to v2.0.8 - Ruby 2.5 is required -3.0.1 -+++++ +## 3.0.1 - Do not show "Assign to me" if assigned_to is disabled for tracker - FontAwesome 5.15.1 support @@ -87,8 +78,7 @@ Changelog - Chart.js 2.9.4 support - Allow overwrite mermaid theme and variables -3.0.0 -+++++ +## 3.0.0 - Introduce dashboards - Redmine 4.1 or newer is required @@ -98,8 +88,7 @@ Changelog - d3plus to v2.0.0-alpha.29 support - drop wiki header and footer settings -2.0.24 -++++++ +## 2.0.24 - FontAwesome 5.13.0 support - Mermaid 8.4.8 support @@ -108,8 +97,7 @@ Changelog - D3 5.16.0 support - Ruby 2.4 is required -2.0.23 -++++++ +## 2.0.23 - members macro now supports with_sum option - FontAwesome 5.12 support @@ -130,8 +118,7 @@ Changelog - asciinema.org macro has been added - thanks to @kotashiratsuka - Select2 4.0.13 support -2.0.22 -++++++ +## 2.0.22 - FontAwesome 5.11.2 support - Mermaid 8.4.2 support @@ -143,8 +130,7 @@ Changelog - Fix user visibility for issue reports - Drop ZeroClipboard library -2.0.21 -++++++ +## 2.0.21 - fix mail notification if issue author changed - fix permission bug for closed issues with freezed mode @@ -155,14 +141,12 @@ Changelog - select2 support - bootstrap-datepicker 1.9.0 support -2.0.20 -++++++ +## 2.0.20 - support single process rake installation #40 - FontAwesome 5.8.0 support -2.0.19 -++++++ +## 2.0.19 - mermaid 8.0.0 support - FontAwesome 5.7.1 support @@ -170,22 +154,19 @@ Changelog - create correct journal entry if issue status changed from sidebar #37 - create correct journal entry if issue has been 'assigned to me' from sidebar -2.0.18 -++++++ +## 2.0.18 - Performance improvement (#36) - FontAwesome 5.6.3 support - Fix problem from migrating from Redmine 3.x to Redmine 4 with lost settings -2.0.17 -++++++ +## 2.0.17 - Fix bug with undefined constant for tags - add possibility to use custom date with date macro - FontAwesome 5.6.0 support -2.0.16 -++++++ +## 2.0.16 - CSS fix for project macro - More compatibility for autocomplete_users with other plugins (like redmine_contacts_helpdesk) @@ -197,8 +178,7 @@ Changelog - cleanup macros: if no data exists, macros is displayed instead of data (before some macros used error messages other hide message at all) -2.0.15 -++++++ +## 2.0.15 - FontAwesome 5.5.0 support - Usability improvement for change author in issue formular @@ -207,8 +187,7 @@ Changelog - Fix problem with help menu and other redmine plugins (compatibility problem with other plugins) - Fix problem with disabled users and changing author for issues -2.0.14 -++++++ +## 2.0.14 - Change status is now compatible with redmine_agile - Do not show sidebar for changing status, if edit_closed_issues permission is missing @@ -219,8 +198,7 @@ Changelog - Show macro list to all logged users at /help/macros - Help menu, with more links to Redmine help pages (which can be used with other plugins, to assign additional entries) -2.0.13 -++++++ +## 2.0.13 - FontAwesome 5.2.0 support - smiley support for markdown text_formatting @@ -231,23 +209,20 @@ Changelog - Redmine 3.4 is required - support sidebar with non default wiki titles (thanks to @danielvijge) -2.0.12 -++++++ +## 2.0.12 - Provide d3 loader function - More robust code for dealing with finding data -2.0.11 -++++++ +## 2.0.11 - i18n methods - FontAwesome 5.0.13 support -2.0.10 -++++++ +## 2.0.10 - Remove bootstrap library -- compatibility with https://www.redmine.org/plugins/issue_id +- compatibility with - bug fix: issue and user macro uses absolute url in mailer notification - Updated marmaid library to version 8.0.0-rc8 - Updated d3 library to 3.5.17 @@ -256,8 +231,7 @@ Changelog - Set default values for ui-tooltip css class - ZeroClipboard updated to 2.3.0 -2.0.9 -+++++ +## 2.0.9 - Updated bootstrap library to 4.0.0 - Drop angular_gantt library @@ -269,29 +243,25 @@ Changelog - FontAwesome 5.0.8 support - Add marmaid library -2.0.8 -+++++ +## 2.0.8 - Provide XLSX helper (and drop XLS helper) - FontAwesome 5.0.6 support - add list support for rake task setting_set -2.0.7 -+++++ +## 2.0.7 - FontAwesome 5.0.2 support - Switching to SLIM template engine -2.0.6 -+++++ +## 2.0.6 - add rake tasks: drop_settings, setting_get and setting_set - Updated nvd3 library to 1.8.6 - Updated angularjs libraries to v2.0.0-rc.1 - Wiki iframe macro integration has been added -2.0.5 -+++++ +## 2.0.5 - Redmine 3.4 bug fixes - Helper function fa_icon renamed to font_awesome_icon because of conflicts with redmine_bootstrap_kit @@ -302,16 +272,14 @@ Changelog - Wiki macro for google maps has been added - Wiki macro for issues now supports display a comment and detect issue id and comment id from URL -2.0.4 -+++++ +## 2.0.4 - Add group_users macro - Fix bug with REST-API and assigned_id for issues - Use user name setting for sort order in macros - Add invisible_captcha spam protection on registration form -2.0.3 -+++++ +## 2.0.3 - Allow remove watchers without re-adding it (only if author or assigned_user changed) - Fix sort order of users for change author @@ -320,52 +288,45 @@ Changelog - Fixed bug with recurring_tasks plugin and autowatch issues - Add more unit tests -2.0.2 -+++++ +## 2.0.2 - Add option to add involved issue users automatically - Add change issue author feature - Fixed bug with Redmine 3.4.x and default assignee settings - Refactoring patch include and wiki macros -2.0.1 -+++++ +## 2.0.1 - Simplified Chinese support has been added (thanks to @archonwang) - Helper function fa_icon has been added - Help menu item and MyPage menu item does not require application server restart anymore - Redmine 3.4.x compatibility -2.0.0 -+++++ +## 2.0.0 - Redmine Tweaks has been renamed to additionals, because to resolve loading order problem of Redmine plugins - Merge common_libraries plugin into additionals plugin - Fontawesome support - Redmine 3.0.x required -1.0.3 -+++++ +## 1.0.3 - TradingView macro support - CryptoCompare macro support - Reddit macro support - Twitter macro improved with prefix image -1.0.2 -+++++ +## 1.0.2 - Smiley/Emoji legacy support -1.0.1 -+++++ +## 1.0.1 - Coding standard cleanups - ruby 2.1.5 required or newer - version bump -1.0.0 -+++++ +## 1.0.0 - user group support for issue auto assign - optimize deface overwrite path @@ -376,8 +337,7 @@ Changelog - wiki pdf settings has been added - updated documentation -0.5.8 -+++++ +## 0.5.8 - Fixed top menu items permissions for anonymous and non member #29 - Fixed bug with overwriting application handler, which cases problem with other plugins @@ -386,7 +346,7 @@ Changelog - more formats for user macro and avatar support - rename list_users to members - rename list_projects to projects -- new documentation on https://redmine-tweaks.readthedocs.io +- new documentation on - updated bootstrap-datepicker and fixed zh locale problem - html validation error has been fixed - remove garfield support (because there is no image source server available) @@ -395,16 +355,14 @@ Changelog - autoassign issue if no assignee is selected - n+1 query optimization -0.5.7 -+++++ +## 0.5.7 - Custom source URL for Garfield source - Wiki footer bug fixed with missing line break at the end of page - date period support for calendar macro - Code cleanups -0.5.6 -+++++ +## 0.5.6 - Redmine 3.2.x compatibility - user macro has been added (user#1 or user:admin) @@ -418,8 +376,7 @@ Changelog - gist macro support - vimeo macro support -0.5.5 -+++++ +## 0.5.5 - dependency with deface (used to overview views) - fixed garfield caching macro problem @@ -427,94 +384,79 @@ Changelog - some content and view optimization (removed wiki_sidebar compatibility problems with other Redmine plugins) - Code cleanups and refactoring -0.5.4 -+++++ +## 0.5.4 - issue rule added for closing issue with open sub issues - issue rule added for status change - issue rule added for assigned_to change -0.5.3 -+++++ +## 0.5.3 - Redmine 3.0.x and 3.1.x supported - "New issue" link with list_projects macro - Parameter syntax changed for list_users and list_projects macros (sorry for that) -0.5.2 -+++++ +## 0.5.2 - "Edit closed issue" permission has been added - Permissions supported for top menu items -0.5.1 -+++++ +## 0.5.1 - "Hide role in memberbox" has been added -0.5.0 -+++++ +## 0.5.0 - Redmine 2.6.x compatibility - URL fixes - Garfield macro has been added -0.4.9 -+++++ +## 0.4.9 - added overview text field - fix style for "goto top" - added macro overview help page - fix compatibility problems with sidebar and other plugins -0.4.8 -+++++ +## 0.4.8 - added youtube macro - project guide subject can be defined for project overview page -0.4.7 -+++++ +## 0.4.7 - added jump to top link - top menu item configuration has been added - footer configuration (e.g. for imprint url) has been added -0.4.6 -+++++ +## 0.4.6 - initialize plugins settings now works with other plugins -0.4.5 -+++++ +## 0.4.5 - option to remove help menu item - Redmine 2.4.1 required -0.4.4 -+++++ +## 0.4.4 - installation error fixed - description update for link handling - help url now opens in new windows - sidebar error has been fixed, if no wiki page already exist -0.4.3 -+++++ +## 0.4.3 - global gantt and calendar bug fix -0.4.2 -+++++ +## 0.4.2 - no requirements of Wiki extensions plugin anymore -0.4.1 -+++++ +## 0.4.1 - Fix problem with my page permission -0.4.0 -+++++ +## 0.4.0 - First public release diff --git a/MACROS.md b/MACROS.md new file mode 100644 index 00000000..d87ae1ef --- /dev/null +++ b/MACROS.md @@ -0,0 +1,35 @@ +# Additionals macro + +## Youtube + +Youtube wiki macro for Redmine. + +### {{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 +- :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 + +```text + {{youtube(wvsboPUjrGc)}} + +Youtube video with size 853x480 + +```text + {{youtube(wvsboPUjrGc, width=853, height=480)}} + +Youtube video with auto play + +```text + {{youtube(wvsboPUjrGc, autoplay=true)}} diff --git a/README.md b/README.md new file mode 100644 index 00000000..32d67deb --- /dev/null +++ b/README.md @@ -0,0 +1,200 @@ +# 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. + +* Redmine.org plugin page: +* Github: + +[![Rate at redmine.org](https://img.shields.io/badge/rate%20at-redmine.org-blue.svg?style=flat)](https://www.redmine.org/plugins/additionals) [![Run Linters](https://github.com/AlphaNodes/additionals/workflows/Run%20Linters/badge.svg)](https://github.com/AlphaNodes/additionals/actions?query=workflow%3A%22Run+Linters%22) [![Run Tests](https://github.com/AlphaNodes/additionals/workflows/Tests/badge.svg)](https://github.com/AlphaNodes/additionals/actions?query=workflow%3ATests) + +## Requirements + +| Name | requirement | +| -------------------|----------------------------------| +| `Redmine` version | >= 5.0 | +| `Ruby` version | >= 2.7 | +| Database version | MySQL >= 8.0 or PostgreSQL >= 10 | + +.. 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 + +Install `additionals` plugin for `Redmine`. + +```shell + cd $REDMINE_ROOT + git clone -b stable https://github.com/AlphaNodes/additionals.git plugins/additionals + bundle config set --local without 'development test' + bundle install + 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. + +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. + +```shell + cd $REDMINE_ROOT/plugins/additionals + git pull + cd ../.. + bundle install + 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. + +```shell + 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 + +* 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 + * 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 + * 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 "Help" from top menu +* 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 +* create issue on user profile +* "assign to me" link on issue +* change issue state on sidebar +* configurable issue rules + + * freeze closed issue + * 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 : + +* [Chart.js Plugin colorschemes 0.4.0 (patched for chartjs 3)](https://github.com/nagix/chartjs-plugin-colorschemes) +* [Chart.js Plugin datalabels 2.0.0](https://github.com/chartjs/chartjs-plugin-datalabels) +* [Chart.js Plugin matrix 1.1.1](https://github.com/kurkle/chartjs-chart-matrix) +* [clipboardJS 2.0.10](https://clipboardjs.com/) +* [d3 7.4.4](https://d3js.org/) +* [d3plus 2.0.1](https://d3plus.org/) +* [FontAwesome 5.15.4](https://fontawesome.com/) +* [mermaid 9.0.1](https://github.com/mermaid-js/mermaid) +* [moment 2.29.2](https://github.com/moment/moment) (used by Chart.js) +* [Select2 4.0.13](https://select2.org/) + +And a set of various Rails helper methods (see below). + +It provides the following Rails helper methods : + +## Libraries assets loader + +```ruby + additionals_library_load(module_name) + +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 +* font_awesome +* mermaid +* select2 + +### Redmine Plugins, which are using *`additionals* + +* [additional_tags](https://github.com/AlphaNodes/additional_tags) +* [redmine_automation](https://alphanodes.com/redmine-automation) +* [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/AlphaNodes/redmine_saml) +* [redmine_passwords](https://alphanodes.com/redmine-passwords) +* [redmine_issue_view_columns](https://github.com/AlphaNodes/redmine_issue_view_columns) +* [redmine_privacy_terms](https://github.com/AlphaNodes/redmine_privacy_terms) +* [redmine_reporting](https://alphanodes.com/redmine-reporting) +* [redmine_servicedesk](https://alphanodes.com/redmine-servicedesk) +* [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). + +## You need a feature + +.. _AlphaNodes: https://alphanodes.com +.. _Open-source: https://opensource.org/osd + +`Additionals`_ is `Open-source`_ and it is available at `Github `_ + +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. + + + + +## Contact and Support + +I am glad about your feedback on the plugin, `pull requests `_, `issues `_, whatever. Feel free to contact me for any questions. diff --git a/README.rst b/README.rst deleted file mode 120000 index d46ade85..00000000 --- a/README.rst +++ /dev/null @@ -1 +0,0 @@ -docs/index.rst \ No newline at end of file