From cfff45535a45cb99ab953c994852b38463d4a0e6 Mon Sep 17 00:00:00 2001 From: Daniel Munn Date: Wed, 20 Jun 2012 08:48:53 +0100 Subject: [PATCH] Switch to Markdown --- CHANGELOG.md | 20 +++++++ CHANGELOG.rdoc | 7 --- README.md | 156 +++++++++++++++++++++++++++++++++++++++++++++++++ README.rdoc | 139 ------------------------------------------- 4 files changed, 176 insertions(+), 146 deletions(-) create mode 100644 CHANGELOG.md delete mode 100644 CHANGELOG.rdoc create mode 100644 README.md delete mode 100644 README.rdoc diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..9d65e279 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,20 @@ +Changelog for Redmine DMSF +========================== + +1.4.2: *Not-yet-released* +------------------------- +* New: Integration test cases for webdav functionality +* Update: Documentation has been converted from Simpletext to Markdown +* Fix: Issue #3 - "webdav broken until set in Administrator -> Settings" +* Fix: Issue #5 - "Webdav incorrectly provides empty listing for non-DMSF enabled projects" +* Fix: Issues identified by test cases + +1.4.1: *2012-06-15* +----------------- +* New: DAV4Rack requirement added (Gemfile makes reference to github repository for latest release). +* New: Webdav functionality included, additional administrative settings added +* Fixed: Issue #2 - extended xapian search fixed with Rails 3 compatible code. + +1.4.0: *2012-06-06* +----------------- +* New: Redmine 2.0 or higher is required \ No newline at end of file diff --git a/CHANGELOG.rdoc b/CHANGELOG.rdoc deleted file mode 100644 index 2d363835..00000000 --- a/CHANGELOG.rdoc +++ /dev/null @@ -1,7 +0,0 @@ -[1.4.1: 2012-06-15] -* New: DAV4Rack requirement added (Gemfile makes reference to github repository for latest release). -* New: Webdav functionality included, additional administrative settings added -* Fixed: Issue #2 - extended xapian search fixed with Rails 3 compatible code. - -[1.4.0: 2012-06-06] -* New: Redmine 2.0 or higher is required \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..4889774c --- /dev/null +++ b/README.md @@ -0,0 +1,156 @@ +Redmine DMSF Plugin +=================== + +Redmine DMSF is Document Management System Features plugin for Redmine issue tracking system; It is aimed to replace current Redmine's Documents module. + +Redmine DMSF now comes bundled with Webdav functionality: if switched on within plugin settings this will be accessible from /dmsf/webdav. + +Initial development was for Kontron AG R&D department and it is released as open source thanks to their generosity. +Project home: + +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 + +Further information about the GPL license can be found at + + +Dependencies +------------ + +As of version 1.4.2 of this plugin: + + * Redmine 2.0.x + * Rails 3.2.x (Inline with Redmine installation requirement) + * zip (Gem) + * DAV4Rack (Github Gem) + +### Fulltext search (optional) + +If you want to use fulltext search abilities: + + * Xapian () search engine + * Xapian Omega indexing tool + * Xapian ruby bindings - xapian or xapian-full gem + +To index some files with omega you may have to install some other packages like +xpdf, antiword, ... + +From Omega documentation: + + * PDF (.pdf) if pdftotext is available (comes with xpdf) + * PostScript (.ps, .eps, .ai) if ps2pdf (from ghostscript) and pdftotext (comes with xpdf) are available + * OpenOffice/StarOffice documents (.sxc, .stc, .sxd, .std, .sxi, .sti, .sxm, .sxw, .sxg, .stw) if unzip is available. + * OpenDocument format documents (.odt, .ods, .odp, .odg, .odc, .odf, .odb, .odi, .odm, .ott, .ots, .otp, .otg, .otc, .otf, .oti, .oth) if unzip is available + * MS Word documents (.doc, .dot) if antiword is available + * MS Excel documents (.xls, .xlb, .xlt) if xls2csv is available (comes with catdoc) + * MS Powerpoint documents (.ppt, .pps) if catppt is available (comes with catdoc) + * MS Office 2007 documents (.docx, .dotx, .xlsx, .xlst, .pptx, .potx, .ppsx) if unzip is available + * Wordperfect documents (.wpd) if wpd2text is available (comes with libwpd) + * MS Works documents (.wps, .wpt) if wps2text is available (comes with libwps) + * AbiWord documents (.abw) + * Compressed AbiWord documents (.zabw) if gzip is available + * Rich Text Format documents (.rtf) if unrtf is available + * Perl POD documentation (.pl, .pm, .pod) if pod2text is available + * TeX DVI files (.dvi) if catdvi is available + * DjVu files (.djv, .djvu) if djvutxt is available + * XPS files (.xps) if unzip is available + +On Debian use: + +```apt-get install libxapian-ruby1.8 xapian-omega libxapian-dev xpdf antiword unzip\ +catdoc libwpd8c2a libwps-0.1-1 gzip unrtf catdvi djview djview3``` + +On Ubuntu use: + +```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``` + +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 "Dmsf files" checkbox will be visible, allowing you to search DMSF content exclusively. + +###Linking DMSF files from Wiki entries: + +####Link to file with id 17: +`{{dmsf(17)}}` + +####Link to file with id 17 with link text "File" +`{{dmsf(17,File)}}` + +The DMSF file/revision id can be found in link for file/revision download from within redmine. + +###Linking DMSF folders from Wiki entries: + +####Link to folder with id 5: +`{{dmsff(5)}}` + +####Link to folder with id 5 with link text "Folder" +`{{dmsff(5,Folder)}}` + +The DMSF folder id can be found in the link when opening folders within Redmine. + +You can also publish Wiki help description: In the file /public/help/wiki_syntax_detailed.html, after the document link description/definition: + +
    +
  • + DMSF: +
      +
    • {{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)
      • +
    • {{dmsff(5)}} (link to folder with id 5)
      • +
    • {{dmsff(5,Folder)}} (link to folder with id 5 with link text "Folder")
      • +
    + The DMSF file/revision id can be found in link for file/revision download from within redmine.
    + The DMSF folder id can be found in the link when opening folders within Redmine. +
    • +
+ +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` +*Ensure that the path used in the above is adjusted for your installation* +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. + +It is necessary to index DMSF files with omega before searching attemts to recieve some output: + + omindex -s english -l 1 -U / --db {path to index database from configuration} {path to storage from configuration} + +This command must be run on regular basis (e.g. from cron) + +Example of cron job (once per hour at 8th minute): + + 8 * * * * root /usr/bin/omindex -s english -l 1 -U / --db /opt/redmine/files/dmsf_index /opt/redmine/files/dmsf + +Use omindex -h for help. + +Uninstalling DMSF +----------------- +Before uninstalling the DMSF plugin, please ensure that the Redmine instance is stopped. + +1. `cd [redmine-install-dir]` +2. `rake redmine:plugin:migrate NAME=redmine_dmsf VERSION=0` +3. `rm plugins/redmine_dmsf -Rf` + +After these steps re-start your instance of Redmine. + +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. \ No newline at end of file diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index 1b6a1d79..00000000 --- a/README.rdoc +++ /dev/null @@ -1,139 +0,0 @@ -=Redmine DMSF Plugin - -Redmine DMSF is Document Management System Features plugin for Redmine issue tracking system. - -It is aimed to replace current Redmine's Documents module. - -Redmine DMSF now comes bundled with Webdav functionality, if switched on within administrative console - will be accessible from /dmsf/webdav. - -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/ - -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 - -Further information about the GPL license can be found at http://www.gnu.org/licenses/old-licenses/gpl-2.0.html#SEC1 - -== Dependencies - -As of version 1.4.1 of this plugin: -* Redmine 2.0.x -* Rails 2.3.x (Inline with Redmine installation requirement) -* Zip (Gem) -* DAV4Rack (Github Gem) - -=== Fulltext search (optional) - -If you want to use fulltext search abilities: -* Xapian (http://xapian.org) search engine -* Xapian Omega indexing tool -* Xapian ruby bindings - xapian or xapian-full gem - -To index some files with omega you may have to install some other packages like xpdf, antiword, ... - -From Omega documentation: - - * PDF (.pdf) if pdftotext is available (comes with xpdf) - * PostScript (.ps, .eps, .ai) if ps2pdf (from ghostscript) and pdftotext (comes with xpdf) are available - * OpenOffice/StarOffice documents (.sxc, .stc, .sxd, .std, .sxi, .sti, .sxm, .sxw, .sxg, .stw) if unzip is available - * OpenDocument format documents (.odt, .ods, .odp, .odg, .odc, .odf, .odb, .odi, .odm, .ott, .ots, .otp, .otg, .otc, .otf, .oti, .oth) if unzip is available - * MS Word documents (.doc, .dot) if antiword is available - * MS Excel documents (.xls, .xlb, .xlt) if xls2csv is available (comes with catdoc) - * MS Powerpoint documents (.ppt, .pps) if catppt is available (comes with catdoc) - * MS Office 2007 documents (.docx, .dotx, .xlsx, .xlst, .pptx, .potx, .ppsx) if unzip is available - * Wordperfect documents (.wpd) if wpd2text is available (comes with libwpd) - * MS Works documents (.wps, .wpt) if wps2text is available (comes with libwps) - * AbiWord documents (.abw) - * Compressed AbiWord documents (.zabw) if gzip is available - * Rich Text Format documents (.rtf) if unrtf is available - * Perl POD documentation (.pl, .pm, .pod) if pod2text is available - * TeX DVI files (.dvi) if catdvi is available - * DjVu files (.djv, .djvu) if djvutxt is available - * XPS files (.xps) if unzip is available - -On Debian use: -apt-get install libxapian-ruby1.8 xapian-omega libxapian-dev xpdf antiword unzip\ - catdoc libwpd8c2a libwps-0.1-1 gzip unrtf catdvi djview djview3 - -On Ubuntu use: -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 - -== Usage - -DMSF act as project module so you must check DMSF in project settings. - -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] {{dmsf(17)}} -[Link to file with id 17 with link text "File"] {{dmsf(17,File)}} -[Link to file with id 17 with link text "File" and link pointing to revision 10] {{dmsf(17,File,10)}} -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] {{dmsff(5)}} -[Link to folder with id 5 with link text "Folder"] {{dmsff(5,Folder)}} - -DMSF folder id can be found in link for folder opening. - -You can also publish Wiki help description. -In file /public/help/wiki_syntax_detailed.html include after document link description: -
    -
  • - DMSF: -
      -
    • {{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)
      • -
    • {{dmsff(5)}} (link to folder with id 5)
      • -
    • {{dmsff(5,Folder)}} (link to folder with id 5 with link text "Folder")
      • -
    - DMSF file/revision id can be found in link for file/revision download.
    - DMSF folder id can be found in link for folder opening. -
    • -
- -== 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. - -It is necessary to index DMSF files with omega before searching attemts to recieve some output: - omindex -s english -l 1 -U / --db {path to index database from configuration} {path to storage from configuration} - -This command must be run on regular basis (e.g. from cron) - -Example of cron job (once per hour at 8th minute): - 8 * * * * root /usr/bin/omindex -s english -l 1 -U / --db /opt/redmine/files/dmsf_index /opt/redmine/files/dmsf - -Use omindex -h for help. - -== Uninstalling DMSF - -Before uninstalling the DMSF plugin, please ensure that the Redmine instance is stopped. - -1. cd [redmine-install-dir] -2. rake redmine:plugin:migrate NAME=redmine_dmsf VERSION=0 -3. rm plugins/redmine_dmsf -Rf - -After these steps re-start your instance of Redmine. - -==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. \ No newline at end of file