.. redmine_tweaks documentation master file, created by
   sphinx-quickstart on Sat Apr 23 16:31:21 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. _Redmine: https://www.redmine.org
.. _Ruby: https://www.ruby-lang.org
.. _PluginGemfile: https://github.com/alphanodes/redmine_tweaks/blob/master/PluginGemfile

Welcome to Redmine Tweaks Plugin
================================

Tweaks for wiki and content including new macros for `Redmine`_.

* Documentation: https://redmine-tweaks.readthedocs.io
* Redmine.org plugin page: https://www.redmine.org/plugins/redmine_tweaks
* Github: https://github.com/alphanodes/redmine_tweaks

.. image:: https://gemnasium.com/badges/github.com/AlphaNodes/redmine_tweaks.svg
   :target: https://gemnasium.com/github.com/AlphaNodes/redmine_tweaks

.. image:: https://pm.alphanodes.com/jenkins/buildStatus/icon?job=Devel-build-redmine-tweaks
   :target: https://pm.alphanodes.com/jenkins/buildStatus/icon?job=Devel-build-redmine-tweaks
   :alt: Jenkins Build Status

.. image:: https://readthedocs.org/projects/redmine-tweaks/badge/?version=latest
   :target: http://redmine-tweaks.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

Requirements
------------

+--------------------+----------------------+
| `Redmine`_ version | >= 2.6.0             |
+--------------------+----------------------+
| `Ruby`_ version    | >= 2.1.5             |
+--------------------+----------------------+
| Gem packages       | see `PluginGemfile`_ |
+--------------------+----------------------+


Installation
------------

Install ``redmine_tweaks`` plugin for `Redmine`_.

.. code-block:: bash

  $ cd $REDMINE_ROOT
  $ git clone git://github.com/alphanodes/redmine_tweaks.git plugins/redmine_tweaks
  $ bundle install --without development test
  $
  $ # if you want to use smiley/emoji legacy support, run:
  $ bundle exec gemoji extract public/images/emoji

Restart your application server (apache with passenger, nginx with passenger, unicorn, puma, etc.) and ``redmine_tweaks`` 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>`_.

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: date, Gihub gist, issues, members, projects slideshare, twitter, user, youtube and vimeo
* option to remove "my page" from top menu
* customize "Help" url in top menu
* customize top menu items
* disable (hide) modules for projects
* open external urls in new window
* smiley/emoji legacy support
* anonymize referrer for external urls
* Hide role in project memberbox
* Configurable issue rules

  * closing issue with open sub issues
  * change assigned_to automatically, if issue status changes
  * assigned_to has changed, but status change is required, too


Contact and Support
--------------------

I am glad about your feedback on the plugin, `pull requests <https://github.com/alphanodes/redmine_tweaks/pulls>`_, `issues <https://github.com/alphanodes/redmine_tweaks/issues>`_, whatever. Feel free to contact me for any questions.


.. toctree::
    :maxdepth: 2

    manual
    macros
    new_feature
    changelog