openproject/README.md

OpenProject PDF Export Plugin
===========================

This Plugin adds features which enable the configuration and generation of printable taskboard card PDFs.


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

The OpenProject PDF Export plug-in requires the [OpenProject Core](https://github.com/opf/openproject/) in
version greater or equal to *3.0.0pre37*.

Tests for this plugin require `pdf-inspector`, so just add the following line to
OpenProject's `Gemfile.plugin`:

`gem "pdf-inspector", "~>1.0.0", :group => :test`


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

OpenProject PDF Export depends on OpenProject Plugins. Thus, if you haven't done
it already, add the following line to the `Gemfile.plugins` to your OpenProject installation:

`gem "openproject-plugins", git: "https://github.com/opf/openproject-plugins.git", :branch => "dev"`

For OpenProject PDF Export itself you need to add the following line to the
`Gemfile.plugins` of the project which is using the plugin:

`gem "openproject-pdf_export", git: "https://github.com/finnlabs/openproject-pdf_export.git", :branch => "dev"`

Afterwards, run:

`bundle install`

This plugin contains migrations. To migrate the database, run:

`rake db:migrate`

There is a seed file to load a default TaskboardCardConfiguration model, although this is not strictly required.


Deinstallation
--------------

Remove the line

`gem "openproject-pdf_export", git: "https://github.com/finnlabs/openproject-backlogs.git"`

from the file `Gemfile.plugins` and run:

`bundle install`

Please not that this leaves plugin data in the database. Currently, we do not
support full uninstall of the plugin.

Usage
------------

The plugin provides an admin interface for TaskboardCardConfiguration CRUD. Existing TaskboardCardConfigurations can then be used to export data in PDF form, the configuration defining the layout of the card and the specific data which appears in it. The DocumentGenerator init takes a TaskboardCardConfiguration and an array of any object. It is left to the developer to make sure the fields in the config match the given data. A TaskboardCardConfiguration currently allows for the following fields to be defined:

Name - A unique identifier for the configuration.
Per Page - The number of taskboard cards which will appear on each page of the exported PDF.
Page Size - Currently we only support A4 paper size.
Orientation - Portrait of Landscape.
Rows - A YAML text block which defines in detail what should appear in each row and column of the taskboard cards.

The following sample YAML shows the required form and all of the available configuration options:

rows:
  row1:
    has_border: false
    columns:
      id:
        has_label: false
        font_size: 20
        font_style: bold
        priority: 1
        minimum_lines: 2
        render_if_empty: false
        width: 30%
      due_date:
        has_label: false
        font_size: 15
        font_style: italic
        priority: 1
        minimum_lines: 2
        render_if_empty: false
        width: 70%
  row2:
    has_border: false
    columns:
      status:
        has_label: true
        font_size: 15
        font_style: normal
        priority: 2
        minimum_lines: 1
        render_if_empty: true

Any number of rows can be defined. The font_size and minimum_lines properties define how much height on the card is given to the row. The plugin will attempt to assign enough space to each of the rows, however space will be assigned based on the priorities of the the rows, with rows with lower priority (higher numbers) being reduced and removed first if there is not enough for all the data.

The name of the column informs the plugin which data should be read from the model (status, due_date, id, etc.). There can be any number of columns per row. Columns are given an equal share of the row width unless a specific width % is given. If there is more text in the column than can fit into its assinged space on the card then the text will be truncated.

Bug Reporting
-------------

If you find any bugs, you can create a bug ticket at

https://www.openproject.org/projects/plugin-backlogs


Development
-----------

To contribute, you can create pull request on the official repository at
`https://github.com/finnlabs/openproject-pdf_export`


Credits
-------

We thank the original maintainers and developers of [Redmine
Backlogs](http://www.redminebacklogs.net/) as well as
[Chiliproject Backlogs](https://github.com/finnlabs/chiliproject_backlogs) for
their immense work on this plugin. OpenProject Backlogs would not have been
possible without their original contribution. Those contributors are:

* Marnen Laibow-Koser
* Sandro Munda
* friflaj
* Maxime Guilbot
* Andrew Vit
* Joakim Kolsjö
* ibussieres
* Daniel Passos
* Jason Vasquez
* jpic
* Emiliano Heyns
* Mark Maglana
* Joe Heck
* Nate Lowrie

Additionally, we would like to thank

* Deutsche Telekom AG (opensource@telekom.de) for project sponsorhip

Licence
-------

Copyright (C)2013 the OpenProject Foundation (OPF)<br />
Copyright (C)2011 Marnen Laibow-Koser, Sandro Munda<br />
Copyright (C)2010-2011 friflaj<br />
Copyright (C)2010 Maxime Guilbot, Andrew Vit, Joakim Kolsjö, ibussieres, Daniel Passos, Jason Vasquez, jpic, Emiliano Heyns<br />
Copyright (C)2009-2010 Mark Maglana<br />
Copyright (C)2009 Joe Heck, Nate Lowrie

This plugin is licensed under the GNU GPL v3. See doc/COPYRIGHT.md and doc/GPL.txt for details.