additionals/docs/manual.rst

Manual
======

General section
--------------

The general section tab allows you to define some special behaviours for your Redmine installation.
It is divided into two areas called ``Content`` and ``Settings``.

The following plugin options are available to be edited by users with administration rights in the area ``Content``:

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

And the following options can be edited by users with administratios righst in the area ``Settings``:

* Add "Go to top" link. If you have a lot of long pages, it is enabling users to easily return to the top of a page.
* Change the option for ``External urls`` into default behaviour, open in new window or open with NoReferrer.

.. note:: Please restart the application server, if you make changes to the external urls settings.

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

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.

Changes you can make in the area ``Settings`` are:

* Remove "Latest news" from overview page in case you do not use the "News" function very often. Remember: Old news is bad news.

Wiki section
------------

If you click on this tab you get to the area, where users with administration rights can customize contents and settings for your Wiki pages in Redmine.
It is divided into two areas called ``Contents`` and ``PDF Wiki settings``.

Changes you can make in the area ``Contents`` are:

* 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
* Project wide wiki footer. For example to implement some date or author macros (e.g. last_updated_at, last_updated_by)

.. note:: Use simple text, macros and wiki syntax for your content.

Changes you can make in the area ``PDF Wiki settings`` are:

* Wiki PDF header. This block will display the defined text in front of the regular Wiki page content in the PDF view. The use of macros is very restricted. And it is not possible to add images. You can only use your Wiki text syntax to adjust the text display.
* Remove Wiki title from PDF view. When acitvated the general Wiki title info in the page header of the PDF viewl will not be displayed.
* Remove attachments from PDF view. When activated the attachments will not be displayed in the PDF view of a Wiki page.

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.

The following plugin options are available to be edited by users with administration rights in the area ``Content``:

* Note for new tickets. 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.

The following options are available at the moment in the area ``Settings`` where you can define rules which will be used in all projects:

* Issues with open sub-issues cannot be closed
* If "Assignee" is unchanged and the issue status changed from x to y, than the author is assigned to the issue.

.. note:: Use Case for this option: issues should be automatically assigned to autor, if the status changes to "Approval".

* Current issue status x is only allowed if "Assignee" is the current user.

.. note:: Use Case here: Users are only allowed to change the status to "In Progress" if they are the person who is actually working on the issue right now.

* If "Assigned to" is not assigned to a user and the new issue status is x then the issue is auto assigned to the first group with users of the pre-defined role.

.. note:: Use Case: The issue author does not know whom the issue should be assigned to. Or he is unsure who will be responsible for solving the task. In that case the issue for example with the status "To Do" is automatically assigned to the first group, which does contain a user of the pre-selected project manager role. Imagine you have a group called "Support", and there are users assigend to the "Manager" role, this support group will be automatically adressed to solve the issue when the issue author saves it.

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

Here you can define new top menu items and change some standard settings on the menu behaviour.

.. note:: Please restart the application server, if you remove a menu item or change permissions as well as changing the custom help url.

This area offers you the possibility to add up to 5 additional menu items to your Redmine main menu.
The following input fields are available for each entry:

* Name. Enter the name of the menu item.
* URL. Enter an URL starting with ``http://``
* Title (optional)
* Permissions: here you select one ore more existing roles to which the menu item will be displayed. Only members of selected roles will be displayed in this list.

In the ``Settings`` area of the menu tab there are the following functions available.

* Enter a ``Custom help URL`` instead of linking to the help on Redmine.org. Make sure you restart your application server after your changes.
* Remove "Help" from top menu in order to keep the menu shorter.
* Remove "My Page" from top menu in order you don't want your users to use this page.

Macros section
--------------

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.

Additional permissions
----------------------

The following 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.

* Hide in member box
* Show hidden roles in member box
* Edit closed issues
* Log time to closed issues