Skip to content

Commit

Permalink
v3.2.5 ddevel started
Browse files Browse the repository at this point in the history
  • Loading branch information
picman committed Oct 24, 2024
1 parent 601c993 commit e2225ad
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 25 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/rubyonrails.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
name: "GitHub CI"
on:
push:
branches: ["master"]
branches: ["devel"]
pull_request:
branches: ["master"]
branches: ["devel"]
jobs:
plugin_tests:
strategy:
Expand Down
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Changelog for Redmine DMSF
==========================

3.2.5 *???-??-??*
------------------

3.2.4 *2024-10-24*
------------------

Expand Down
35 changes: 13 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
Redmine DMSF Plugin 3.2.4
=========================
# Redmine DMSF Plugin 3.2.5 devel

[![GitHub CI](https://github.com/danmunn/redmine_dmsf/actions/workflows/rubyonrails.yml/badge.svg?branch=master)](https://github.com/danmunn/redmine_dmsf/actions/workflows/rubyonrails.yml)
[![GitHub CI](https://github.com/danmunn/redmine_dmsf/actions/workflows/rubyonrails.yml/badge.svg?branch=devel)](https://github.com/danmunn/redmine_dmsf/actions/workflows/rubyonrails.yml)
[![Support Ukraine Badge](https://bit.ly/support-ukraine-now)](https://github.com/support-ukraine/support-ukraine)

Redmine DMSF is Document Management System Features plugin for Redmine issue tracking system; It is aimed to replace current Redmine's Documents module.
Expand All @@ -19,8 +18,7 @@ Redmine is a flexible project management web application, released under the ter
Further information about the GPL license can be found at
<https://www.gnu.org/licenses/old-licenses/gpl-2.0.html#SEC1>

Features
--------
## Features

* Directory structure
* Document versioning / revision history
Expand All @@ -42,8 +40,7 @@ Features
* DMS Document revision as a custom field type
* Compatible with Redmine 5.0.x

Dependencies
------------
## Dependencies

* Redmine 5.0 or higher

Expand Down Expand Up @@ -134,7 +131,7 @@ sudo yum install xapian-core xapian-bindings-ruby libxapian-dev poppler-utils an
libwps-tools gzip unrtf catdvi djview djview3 uuid uuid-dev xz libemail-outlook-message-perl
```

### Inline displaying of office documents (optional)
## Inline displaying of office documents (optional)

If LibreOffice binary `libreoffice` is present in the server, office documents (.odt, .ods,...) are displayed inline.
The command must be runable by the web app's user. Test it in advance, e.g:
Expand All @@ -147,21 +144,18 @@ The command must be runable by the web app's user. Test it in advance, e.g:
sudo apt install libreoffice liblibreoffice-java
```

Usage
-----
## Usage

DMSF is designed to act as project module, so it must be checked as an enabled module within the project settings.

Search will now automatically search DMSF content when a Redmine search is performed, additionally a "Documents" and "Folders" check box will be visible, allowing you to search DMSF content exclusively.

Linking DMSF object from Wiki entries (macros)
---------------------------------------------
## Linking DMSF object from Wiki entries (macros)

You can link DMSF object from Wikis using a macro tag `{{ }}`. List of available macros with their description is
available from the wiki's toolbar.

Hooks
-----
## Hooks

You can implement these hooks in your plugin and extend DMSF functionality in certain events.

Expand Down Expand Up @@ -200,8 +194,7 @@ expected that the file is sent by the hook.

parameters: *file*

Setup / Upgrade
---------------
## Setup / Upgrade

You can either clone the master branch or download the latest zipped version. Before installing ensure that the Redmine
instance is stopped.
Expand Down Expand Up @@ -316,8 +309,8 @@ it's necessary to add the following configuration option into your `config/addit
config.relative_url_root = '/redmine'
```

Uninstalling DMSF
-----------------
## Uninstalling DMSF

Before uninstalling the DMSF plugin, please ensure that the Redmine instance is stopped.

1. `cd [redmine-install-dir]`
Expand All @@ -326,16 +319,14 @@ Before uninstalling the DMSF plugin, please ensure that the Redmine instance is

After these steps re-start your instance of Redmine.

Contributing
------------
## Contributing

If you've added something, why not share it. Fork the repository (github.com/danmunn/redmine_dmsf),
make the changes and send a pull request to the maintainers.

Changes with tests, and full documentation are preferred.

Additional Documentation
------------------------
## Additional Documentation

[CHANGELOG.md](CHANGELOG.md) - Project changelog

Expand Down
2 changes: 1 addition & 1 deletion init.rb
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
author_url 'https://github.com/danmunn/redmine_dmsf/graphs/contributors'
author 'Vít Jonáš / Daniel Munn / Karel Pičman'
description 'Document Management System Features'
version '3.2.4'
version '3.2.5 devel'

requires_redmine version_or_higher: '5.0.0'

Expand Down

0 comments on commit e2225ad

Please sign in to comment.