redmine_plugins/redmine_dmsf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updating documentation.

Browse Source
This commit is contained in:
Daniel Munn 2012-06-06 11:27:46 +01:00
parent bb53713608
commit 2f6e12af2b
1 changed files with 70 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

121
README.txt → README.rdoc
View File

@ -1,25 +1,25 @@
=Redmine DMSF Plugin
Redmine DMSF is Document Management System Features plugin for Redmine issue tracking system. Redmine DMSF is Document Management System Features plugin for Redmine issue tracking system.
It is aimed to replace current Redmine's Documents module. It is aimed to replace current Redmine's Documents module.
Initial development was for Kontron AG R&D department and it is released as open source thanks to their generosity. Initial development was for Kontron AG R&D department and it is released as open source thanks to their generosity.
Project home: http://code.google.com/p/redmine-dmsf/ Project home: http://code.google.com/p/redmine-dmsf/
1. License Redmine Document Management System "Features" plugin is distributed under GNU General Public License v2 (GPL)
Redmine is a flexible project management web application, released under the terms of the GNU General Public License v2 (GPL) at http://www.redmine.org
Redmine Document Management System "Features" plugin is distributed under GNU GPL version 2. Further information about the GPL license can be found at http://www.gnu.org/licenses/old-licenses/gpl-2.0.html#SEC1
License itself is here: http://www.gnu.org/licenses/old-licenses/gpl-2.0.html#SEC1 == Dependencies
2. Installation As of version 1.4.0 of this plugin:
* Redmine 2.0.x
* Rails 2.3.x (Inline with Redmine installation requirement)
* Zip (Gem)
2.1. Prerequisities === Fulltext search (optional)
* Redmine 1.1.x
* Ruby Zip library - rubyzip gem
2.1.1. Fulltext search (optional)
If you want to use fulltext search abilities: If you want to use fulltext search abilities:
* Xapian (http://xapian.org) search engine * Xapian (http://xapian.org) search engine
@ -48,7 +48,7 @@ From Omega documentation:
* DjVu files (.djv, .djvu) if djvutxt is available * DjVu files (.djv, .djvu) if djvutxt is available
* XPS files (.xps) if unzip is available * XPS files (.xps) if unzip is available
On Debinan (Squeeze) use: On Debian use:
apt-get install libxapian-ruby1.8 xapian-omega libxapian-dev xpdf antiword unzip\ apt-get install libxapian-ruby1.8 xapian-omega libxapian-dev xpdf antiword unzip\
catdoc libwpd8c2a libwps-0.1-1 gzip unrtf catdvi djview djview3 catdoc libwpd8c2a libwps-0.1-1 gzip unrtf catdvi djview djview3
@ -56,19 +56,57 @@ On Ubuntu use:
sudo apt-get install libxapian-ruby1.8 xapian-omega libxapian-dev xpdf antiword unzip\ sudo apt-get install libxapian-ruby1.8 xapian-omega libxapian-dev xpdf antiword unzip\
catdoc libwpd-0.9-9 libwps-0.2-2 gzip unrtf catdvi djview djview3 catdoc libwpd-0.9-9 libwps-0.2-2 gzip unrtf catdvi djview djview3
2.2. Setup/Upgrade == Usage
* In case of upgrade BACKUP YOUR DATABASE first DMSF act as project module so you must check DMSF in project settings.
* Put redmine_dmsf plugin directory into vendor/plugins
* Initialize/Update database:
rake db:migrate:plugins RAILS_ENV="production"
* The access rights must be set for web server, example:
chown -R www-data:www-data /opt/redmine/vendor/plugins/redmine_dmsf
* Restart web server
* You should configure plugin via Redmine interface: Administration -> Plugins -> DMSF -> Configure
* Assign DMSF permissions to appropriate roles
2.2.1. Fulltext search (optional) Search options will now contain "Dmsf files" check, that allows you to search DMSF content.
There is possibility to link DMSF files from Wiki entries:
[Link to file with id 17] <tt>{{dmsf(17)}}</tt>
[Link to file with id 17 with link text "File"] <tt>{{dmsf(17,File)}}</tt>
[Link to file with id 17 with link text "File" and link pointing to revision 10] <tt>{{dmsf(17,File,10)}}</tt>
DMSF file/revision id can be found in link for file/revision download.
There is possibility to link DMSF folders from Wiki entries:
[Link to folder with id 5] <tt>{{dmsff(5)}}</tt>
[Link to folder with id 5 with link text "Folder"] <tt>{{dmsff(5,Folder)}}</tt>
DMSF folder id can be found in link for folder opening.
You can also publish Wiki help description.
In file <redmine_root>/public/help/wiki_syntax_detailed.html include after document link description:
<ul>
<li>
DMSF:
<ul>
<li><strong>{{dmsf(17)}}</strong> (link to file with id 17)</li>
<li><strong>{{dmsf(17,File)}}</strong> (link to file with id 17 with link text "File")</li>
<li><strong>{{dmsf(17,File,10)}}</strong> (link to file with id 17 with link text "File" and link pointing to revision 10)</li>
<li><strong>{{dmsff(5)}}</strong> (link to folder with id 5)</li>
<li><strong>{{dmsff(5,Folder)}}</strong> (link to folder with id 5 with link text "Folder")</li>
</ul>
DMSF file/revision id can be found in link for file/revision download.<br />
DMSF folder id can be found in link for folder opening.
</li>
</ul>
== Setup/Upgrade
Before installing ensure that the Redmine instance is stopped.
1. In case of upgrade BACKUP YOUR DATABASE first
2. Put redmine_dmsf plugin directory into plugins
3. Initialize/Update database:
rake redmine:plugins:migrate RAILS_ENV="production"
4. The access rights must be set for web server, example:
chown -R www-data:www-data /opt/redmine/plugins/redmine_dmsf
5. Restart web server
6. You should configure plugin via Redmine interface: Administration -> Plugins -> DMSF -> Configure
7. Assign DMSF permissions to appropriate roles
=== Fulltext search (optional)
If you want to use fulltext search features, you must setup file content indexing. If you want to use fulltext search features, you must setup file content indexing.
@ -82,36 +120,17 @@ Example of cron job (once per hour at 8th minute):
Use omindex -h for help. Use omindex -h for help.
2.3. Usage == Uninstalling DMSF
DMSF act as project module so you must check DMSF in project settings. Before uninstalling the DMSF plugin, please ensure that the Redmine instance is stopped.
Search options will now contain "Dmsf files" check, that allows you to search DMSF content. 1. <tt>cd [redmine-install-dir]</tt>
2. <tt>rake redmine:plugin:migrate NAME=redmine_dmsf VERSION=0</tt>
3. <tt>rm plugins/redmine_dmsf -Rf</tt>
There is possibility to link DMSF files from Wiki entries: After these steps re-start your instance of Redmine.
{{dmsf(17)}} link to file with id 17
{{dmsf(17,File)}} link to file with id 17 with link text "File"
{{dmsf(17,File,10)}} link to file with id 17 with link text "File" and link pointing to revision 10
DMSF file/revision id can be found in link for file/revision download.
There is possibility to link DMSF folders from Wiki entries: ==Contributing
{{dmsff(5)}} link to folder with id 5 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.
{{dmsff(5,Folder)}} link to folder with id 5 with link text "Folder"
DMSF folder id can be found in link for folder opening.
You can also publish Wiki help description. Changes with tests, and full documentation are preferred.
In file <redmine_root>/public/help/wiki_syntax_detailed.html include after document link description:
<ul>
<li>
DMSF:
<ul>
<li><strong>{{dmsf(17)}}</strong> (link to file with id 17)</li>
<li><strong>{{dmsf(17,File)}}</strong> (link to file with id 17 with link text "File")</li>
<li><strong>{{dmsf(17,File,10)}}</strong> (link to file with id 17 with link text "File" and link pointing to revision 10)</li>
<li><strong>{{dmsff(5)}}</strong> (link to folder with id 5)</li>
<li><strong>{{dmsff(5,Folder)}}</strong> (link to folder with id 5 with link text "Folder")</li>
</ul>
DMSF file/revision id can be found in link for file/revision download.<br />
DMSF folder id can be found in link for folder opening.
</li>
</ul>