Skip to content

Repository files navigation

Most Read — OMP block plugin

OMP Version License

⬇️ Install package: OMP 3.5 — or browse all Releases.

A block plugin for Open Monograph Press (OMP) that adds a "most read books" section to the frontend sidebar. By default the block shows the 5 most-viewed books of the last 7 days, each with its title (linking to the book page) and an eye icon with the full-text view count. The press manager can set a custom heading and a custom time window.

Maintained by OJSBR. Adapted for PKP 3.4/3.5 from the original community plugin by Antti-Jussi Nygård (@ajnyga), with contributions by @zielaq. See the full Credits & authorship section below.

Compatibility & branches

OMP version Branch Plugin release
OMP 3.5.x stable-3_5_0 (default) 3.5.0.3

Looking for the OJS edition? It lives in its own repository, OJSBR/mostRead. This repository is the same plugin with the terminology and the data model of a book publisher.

Installation

  1. Download the release (or clone the branch).
  2. Install via Settings → Website → Plugins → Upload A New Plugin, or extract the folder into plugins/blocks/ so you get plugins/blocks/mostRead/.
  3. Enable the plugin, then activate the Most Read Books block from the press sidebar settings.

Keep the folder name. PKP 3.5 derives the plugin's class namespace from its installation directory, so the folder must be mostRead — the Omp suffix belongs to the repository name only. The release tarball already unpacks with the right name.

Configuration

In the plugin settings the press manager can set a custom block heading and choose the number of days used for the "most read" statistics (default: 7).

Languages

Ships in 7 languages: English, Portuguese (Brazil), Portuguese (Portugal), Spanish, French, Italian and German. Note the French folder is locale/fr — PKP 3.5 has no fr_FR locale, so a fr_FR folder would never be loaded.

Tests

Verified on OMP 3.5.0.4 against a live press: the statistics query returned the 5 most-viewed books with real metrics (71, 51, 34, 32 and 30 views), every link resolved to catalog/book/{id} with HTTP 200, and the block rendered on the home page of the press.

Credits & authorship

  • Maintained by OJSBR — adaptation to PKP 3.4/3.5 and the OMP edition.
  • Original work: the "Most Read Books" block plugin by Antti-Jussi Nygård (@ajnyga, https://github.com/ajnyga/mostRead), with contributions by @zielaq.
  • Distributed under the GNU GPL v3, consistent with the original licensing.

Contributing

Issues and pull requests are welcome. Please target the branch matching the OMP version you are working against.

License

Distributed under the GNU GPL v3. See LICENSE and docs/COPYING.


🇧🇷 Português

Plugin de bloco para o Open Monograph Press (OMP) que adiciona uma seção de "livros mais lidos" à barra lateral. Por padrão mostra os 5 livros mais acessados nos últimos 7 dias, cada um com título (link para a página do livro) e ícone de olho com a contagem de acessos. O gestor pode definir um título personalizado e a janela de dias.

Mantido pela OJSBR. Adaptado para o PKP 3.4/3.5 a partir do plugin comunitário original de Antti-Jussi Nygård (@ajnyga), com contribuições de @zielaq. Veja a seção Créditos e autoria abaixo.

Compatibilidade e branches

Versão do OMP Branch Release do plugin
OMP 3.5.x stable-3_5_0 (padrão) 3.5.0.3

Procurando a versão de OJS? Ela tem repositório próprio, OJSBR/mostRead. Este repositório é o mesmo plugin com a terminologia e o modelo de dados de uma editora de livros.

Instalação

Instale em Configurações → Website → Plugins → Enviar um novo plugin, ou extraia a pasta em plugins/blocks/ (ficando plugins/blocks/mostRead/). Ative o plugin e habilite o bloco Livros mais lidos nas configurações da barra lateral.

Não renomeie a pasta. O PKP 3.5 deriva o namespace da classe do diretório de instalação, então a pasta precisa se chamar mostRead — o sufixo Omp é só do repositório. O pacote de release já descompacta com o nome certo.

Idiomas

Em 7 idiomas: inglês, português (Brasil), português (Portugal), espanhol, francês, italiano e alemão. A pasta do francês é locale/fr — o PKP 3.5 não tem o locale fr_FR, então uma pasta fr_FR nunca seria carregada.

Testes

Verificado no OMP 3.5.0.4 em uma editora real: a consulta de estatísticas devolveu os 5 livros mais vistos com métricas reais (71, 51, 34, 32 e 30 acessos), todos os links resolveram para catalog/book/{id} com HTTP 200, e o bloco renderizou na home da editora.

Créditos e autoria

  • Mantido pela OJSBR — adaptação para o PKP 3.4/3.5 e a edição de OMP.
  • Trabalho original: o bloco "Most Read Books" de Antti-Jussi Nygård (@ajnyga, https://github.com/ajnyga/mostRead), com contribuições de @zielaq.
  • Distribuído sob a GNU GPL v3, coerente com o licenciamento original.

Licença

Distribuído sob a GNU GPL v3. Veja LICENSE e docs/COPYING.

About

OMP 3.5 block plugin: sidebar block with the most-read books of a configurable time window. By OJSBR. · Plugin de bloco OMP 3.5: bloco de barra lateral com os livros mais lidos em uma janela de tempo configuravel. Autoral OJSBR.

Topics

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages