diff --git a/README.md b/README.md index 9529feb..9fcfbce 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ViewerJs (module for Omeka S) ============================= -[ViewerJs] is a module for [Omeka S] that allows to display common document +[`Viewer Js`] is a module for [Omeka S] that allows to display common document formats (pdf, standard office ones), via a light viewer. . Supported formats are: @@ -18,9 +18,9 @@ Omeka S. - Images (jpg, png, gif) - Audio/video (via html5) -Concretely, it includes the [ViewerJS] library, that integrates the pdf library -of Mozilla [pdf.js] and the standard office formats via [WebODF]. The images and -the audio/video are displayed via the browser itself. +Concretely, it includes the [`ViewerJS`] library, that integrates the pdf +library of Mozilla [`pdf.js`] and the standard office formats via [`WebODF`]. The +images and the audio/video are displayed via the browser itself. Note: for office documents, the bigger they are, the bigger should be the computer of the visitor to display them. @@ -29,12 +29,12 @@ computer of the visitor to display them. Installation ------------ -The module uses an external library, [ViewerJS], so use the release zip to +The module uses an external library, [`ViewerJS`], so use the release zip to install it, or use and init the source. * From the zip -Download the last release [ViewerJs.zip] from the list of releases (the master +Download the last release [`ViewerJs.zip`] from the list of releases (the master does not contain the dependency), and uncompress it in the `modules` directory. * From the source and for development: @@ -57,7 +57,7 @@ The next times: * Note about WebODF Because the standards of the [Document Foundation] are "simple" and easy to -manage, the library [WebODF] is mainly a stylesheet. And because this is a true +manage, the library [`WebODF`] is mainly a stylesheet. And because this is a true standard, it is sustainable, stable and available to anyone. So it’s recommended for any office work. @@ -76,6 +76,14 @@ To display the media (images, audio, video) via the ViewerJS, copy and adapt the section `['file_renderers']['aliases']` in `config/module.config.php` in your `config/local.config.php`. +To display the pdf with the more complete viewer provided by the module [Pdf Viewer], +you need to set its value in your local config too: + +``` + 'application/pdf' => 'pdfViewer', + 'pdf' => 'pdfViewer', +``` + Warning ------- @@ -98,59 +106,58 @@ License This module is published under the [CeCILL v2.1] licence, compatible with [GNU/GPL] and approved by [FSF] and [OSI]. -In consideration of access to the source code and the rights to copy, modify and +This software is governed by the CeCILL license under French law and abiding by +the rules of distribution of free software. You can use, modify and/ or +redistribute the software under the terms of the CeCILL license as circulated by +CEA, CNRS and INRIA at the following URL "http://www.cecill.info". + +As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty and the software’s author, the holder of the economic rights, and the -successive licensors only have limited liability. +successive licensors have only limited liability. -In this respect, the risks associated with loading, using, modifying and/or -developing or reproducing the software by the user are brought to the user’s -attention, given its Free Software status, which may make it complicated to use, -with the result that its use is reserved for developers and experienced -professionals having in-depth computer knowledge. Users are therefore encouraged -to load and test the suitability of the software as regards their requirements -in conditions enabling the security of their systems and/or data to be ensured -and, more generally, to use and operate it in the same conditions of security. -This Agreement may be freely reproduced and published, provided it is not -altered, and that no provisions are either added or removed herefrom. - -The [ViewerJS] library is published under the [GNU AGPL] license. -The [WebODF] library is published under the [GNU AGPL] license. -The [pdf.js] library is published under the [Apache] license. - - -Contact -------- +In this respect, the user’s attention is drawn to the risks associated with +loading, using, modifying and/or developing or reproducing the software by the +user in light of its specific status of free software, that may mean that it is +complicated to manipulate, and that also therefore means that it is reserved for +developers and experienced professionals having in-depth computer knowledge. +Users are therefore encouraged to load and test the software’s suitability as +regards their requirements in conditions enabling the security of their systems +and/or data to be ensured and, more generally, to use and operate it in the same +conditions as regards security. -See documentation on the [ViewerJS] library on its site. +The fact that you are presently reading this means that you have had knowledge +of the CeCILL license and that you accept its terms. -Current maintainers of the module: -* Daniel Berthereau (see [Daniel-KM]) +The [`ViewerJS`] library is published under the [GNU AGPL] license. +The [`WebODF`] library is published under the [GNU AGPL] license. +The [`pdf.js`] library is published under the [Apache] license. Copyright --------- -ViewerJS and WebODF libraries: +[`ViewerJS`] and [`WebODF`] libraries: * Copyright KO GmbH, 2013-2017 -Javascript library [pdf.js]: +Javascript library [`pdf.js`]: * Copyright Mozilla, 2011-2017 -Module ViewerJs for Omeka S: +Module Viewer Js for Omeka S: -* Copyright Daniel Berthereau, 2017-2018 +* Copyright Daniel Berthereau, 2017-2018 (see [Daniel-KM]) -[ViewerJs]: https://github.com/Daniel-KM/Omeka-S-module-ViewerJs +[`Viewer Js`]: https://github.com/Daniel-KM/Omeka-S-module-ViewerJs [Omeka S]: https://omeka.org/s -[ViewerJS]: https://viewerjs.org -[ViewerJs.zip]: https://github.com/Daniel-KM/Omeka-S-module-ViewerJs/releases -[pdf.js]: https://mozilla.github.io/pdf.js -[WebODF]: https://github.com/kogmbh/WebODF +[`ViewerJS`]: https://viewerjs.org +[`ViewerJs.zip`]: https://github.com/Daniel-KM/Omeka-S-module-ViewerJs/releases +[`pdf.js`]: https://mozilla.github.io/pdf.js +[`WebODF`]: https://github.com/kogmbh/WebODF [Document Foundation]: https://www.documentfoundation.org +[Pdf Viewer]: https://github.com/Daniel-KM/Omeka-S-module-PdfViewer [module issues]: https://github.com/Daniel-KM/Omeka-S-module-ViewerJs/issues [CeCILL v2.1]: https://www.cecill.info/licences/Licence_CeCILL_V2.1-en.html [GNU/GPL]: https://www.gnu.org/licenses/gpl-3.0.html diff --git a/config/module.ini b/config/module.ini index 0949f14..eb4a907 100644 --- a/config/module.ini +++ b/config/module.ini @@ -1,12 +1,12 @@ [info] name = "ViewerJS" description = "Display standard document formats (pdf and office: pdf, odt, ods, odp) in a light unified player." -tags = "viewer, display" +tags = "viewer, display, document viewer, open document, pdf, odt, ods, odp" license = "CeCILL v2.1" author = "Daniel Berthereau" author_link = "https://github.com/Daniel-KM" module_link = "https://github.com/Daniel-KM/Omeka-S-module-ViewerJs" support_link = "https://github.com/Daniel-KM/Omeka-S-module-ViewerJs/issues" configurable = false -version = "3.1.1" +version = "3.1.2" omeka_version_constraint = "^1.1.0"