{"id":19640633,"url":"https://github.com/daniel-km/omeka-s-module-pdfviewer","last_synced_at":"2025-04-28T11:31:24.832Z","repository":{"id":53171744,"uuid":"158390843","full_name":"Daniel-KM/Omeka-S-module-PdfViewer","owner":"Daniel-KM","description":"Module for Omeka S to display pdf directly in public pages via the browser viewer or a customizable internal viewer.","archived":false,"fork":false,"pushed_at":"2023-06-13T18:34:26.000Z","size":4098,"stargazers_count":2,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-05T08:34:57.649Z","etag":null,"topics":["omeka-s","omeka-s-module","pdf","pdf-viewer","pdfjs"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Daniel-KM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-20T13:05:59.000Z","updated_at":"2023-02-02T11:30:55.000Z","dependencies_parsed_at":"2023-02-10T10:15:59.634Z","dependency_job_id":null,"html_url":"https://github.com/Daniel-KM/Omeka-S-module-PdfViewer","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daniel-KM%2FOmeka-S-module-PdfViewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daniel-KM%2FOmeka-S-module-PdfViewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daniel-KM%2FOmeka-S-module-PdfViewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daniel-KM%2FOmeka-S-module-PdfViewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Daniel-KM","download_url":"https://codeload.github.com/Daniel-KM/Omeka-S-module-PdfViewer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251304897,"owners_count":21567962,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["omeka-s","omeka-s-module","pdf","pdf-viewer","pdfjs"],"created_at":"2024-11-11T14:06:19.202Z","updated_at":"2025-04-28T11:31:19.821Z","avatar_url":"https://github.com/Daniel-KM.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Pdf Viewer (module for Omeka S)\n===============================\n\n\u003e __New versions of this module and support for Omeka S version 3.0 and above\n\u003e are available on [GitLab], which seems to respect users and privacy better\n\u003e than the previous repository.__\n\n[Pdf Viewer] is a module for [Omeka S] that allows to display pdf files\nwith the browser reader or via the customizable internal reader, the same Mozilla\nlibrary [pdf.js], at the choice of the admin and site admins.\n\n\nInstallation\n------------\n\nThe module uses an external library, [pdf.js], so use the release zip to\ninstall it, or use and init the source.\n\nSee general end user documentation for [installing a module].\n\n* From the zip\n\nDownload the last release [PdfViewer.zip] from the list of releases (the\nmaster does not contain the dependency), and uncompress it in the `modules`\ndirectory.\n\n* From the source and for development\n\nIf the module was installed from the source, rename the name of the folder of\nthe module to `PdfViewer`, and go to the root module, and run:\n\n```sh\ncomposer install --no-dev\n```\n\nThe assets are a slightly modified version of the generic viewer. They can be\nrebuild if needed with the script \"build.php\", that is automatically run from\ncomposer during install.\n\n```sh\nnpm install\ncd node_modules/pdf.js\nnpm install\ngulp dist\n# The package version for composer contains the standard minified version from\n# the directory \"build\" and the \"generic\" viewer.\ncd ../..\nrm -rf /tmp/pdf.js\ncp -r node_modules/pdf.js/build/generic/ /tmp/pdf.js/\nrm /tmp/pdf.js/web/compressed.tracemonkey-pldi-09.pdf\ncp node_modules/pdf.js/build/dist/build/pdf.min.js /tmp/pdf.js/build/\ncp node_modules/pdf.js/build/dist/build/pdf.worker.min.js /tmp/pdf.js/build/\nrm -rf asset/vendor/pdf.js\ncp -r /tmp/pdf.js asset/vendor\nphp -f data/scripts/build.php\n# For release.\ntar czf /tmp/pdf.js.tar.gz /tmp/pdf.js\n```\n\nIn some cases, when using an old version of pdf.js, the argument `--legacy-peer-deps`\nshould be added to npm.\n\n\nConfig\n------\n\nAll resources of Omeka S that are in pdf are automatically displayed by the\nPdf Viewer, so you have nothing to do.\n\nOptions can be set differently for each site:\n\n- in site settings for the integration of the player;\n- in the json file \"config.json\" of pdf.js for the player itself: copy and\n  update the files in `asset/vendor/pdfjs` and/or the file `common/pdf-viewer-inline.phtml`\n  inside your theme.\n\n\nWarning\n-------\n\nUse it at your own risk.\n\nIt’s always recommended to backup your files and your databases and to check\nyour archives regularly so you can roll back if needed.\n\n\nTroubleshooting\n---------------\n\nSee online issues on the [module issues] page on GitLab.\n\n\nLicense\n-------\n\nThis module is published under the [CeCILL v2.1] license, compatible with\n[GNU/GPL] and approved by [FSF] and [OSI].\n\nThis software is governed by the CeCILL license under French law and abiding by\nthe rules of distribution of free software. You can use, modify and/ or\nredistribute the software under the terms of the CeCILL license as circulated by\nCEA, CNRS and INRIA at the following URL \"http://www.cecill.info\".\n\nAs a counterpart to the access to the source code and rights to copy, modify and\nredistribute granted by the license, users are provided only with a limited\nwarranty and the software’s author, the holder of the economic rights, and the\nsuccessive licensors have only limited liability.\n\nIn this respect, the user’s attention is drawn to the risks associated with\nloading, using, modifying and/or developing or reproducing the software by the\nuser in light of its specific status of free software, that may mean that it is\ncomplicated to manipulate, and that also therefore means that it is reserved for\ndevelopers and experienced professionals having in-depth computer knowledge.\nUsers are therefore encouraged to load and test the software’s suitability as\nregards their requirements in conditions enabling the security of their systems\nand/or data to be ensured and, more generally, to use and operate it in the same\nconditions as regards security.\n\nThe fact that you are presently reading this means that you have had knowledge\nof the CeCILL license and that you accept its terms.\n\nThe [pdf.js] library is published under the [Apache] license.\n\n\nCopyright\n---------\n\nJavascript library [pdf.js]:\n\n* Copyright Mozilla, 2011-2021\n\nModule Pdf Viewer for Omeka S:\n\n* Copyright Daniel Berthereau, 2017-2023 (see [Daniel-KM] on GitLab)\n\n\n[Pdf Viewer]: https://gitlab.com/Daniel-KM/Omeka-S-module-PdfViewer\n[Omeka S]: https://omeka.org/s\n[pdf.js]: https://mozilla.github.io/pdf.js\n[Installing a module]: https://omeka.org/s/docs/user-manual/modules/#installing-modules\n[PdfViewer.zip]: https://gitlab.com/Daniel-KM/Omeka-S-module-PdfViewer/-/releases\n[module issues]: https://gitlab.com/Daniel-KM/Omeka-S-module-PdfViewer/-/issues\n[CeCILL v2.1]: https://www.cecill.info/licences/Licence_CeCILL_V2.1-en.html\n[GNU/GPL]: https://www.gnu.org/licenses/gpl-3.0.html\n[FSF]: https://www.fsf.org\n[OSI]: http://opensource.org\n[Apache]: https://github.com/mozilla/pdf.js/blob/master/LICENSE\n[GitLab]: https://gitlab.com/Daniel-KM\n[Daniel-KM]: https://gitlab.com/Daniel-KM \"Daniel Berthereau\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaniel-km%2Fomeka-s-module-pdfviewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaniel-km%2Fomeka-s-module-pdfviewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaniel-km%2Fomeka-s-module-pdfviewer/lists"}