⬇️ Install package: OJS 3.5 · OJS 3.4 · OJS 3.3 — or browse all Releases.
A block plugin for Open Journal Systems (OJS) that embeds the official VLibras widget — the Brazilian federal government's Portuguese-to-Libras (Brazilian Sign Language) translator, with its floating 3D avatar — so deaf readers can translate the journal's content. No core patching.
Developed and maintained by OJSBR. VLibras itself is a product of the Brazilian government (see Credits).
| OJS version | Branch | Plugin release |
|---|---|---|
| OJS 3.5.x | stable-3_5_0 (default) |
1.0.1.1 |
| OJS 3.4.x | stable-3_4_0 |
1.0.1.1-ojs3.4 |
| OJS 3.3.x | stable-3_3_0 |
1.0.1.1-ojs3.3 |
Deaf readers in Brazil often have Libras, not written Portuguese, as their first language. The Brazilian government publishes a free widget that translates web page text into Libras with a 3D avatar, but adding it to a journal means editing the theme's templates.
- Loads the official VLibras widget from
https://vlibras.gov.br/app, showing the floating Libras avatar on every front-end page of the journal. - Readers click the avatar and select text to see it translated into Libras.
- Ships a small labelled block for the sidebar so editors can position and describe it.
- Block title and text translated into 38 languages (33 on OJS 3.3, whose language list is shorter); the widget itself translates Portuguese content into Libras.
- Download the release for your OJS version (or clone the matching branch).
- Install via Settings → Website → Plugins → Upload A New Plugin, or extract the folder
into
plugins/blocks/so you getplugins/blocks/vlibras/. - Enable VLibras Block (Brazilian Sign Language) under the Block plugins list.
- Place the block in your sidebar under Settings → Website → Appearance → Sidebar.
- A
BlockPluginrenderstemplates/block.tpland queuesjs/vlibras.jsfor reader pages (addJavaScript, printed at the end of the page). The template holds no script. - The loader creates the official VLibras markup (
<div vw>…) as a direct child of<body>, as the VLibras documentation places it, so the sidebar's CSS never affects the floating avatar. - The widget script is loaded asynchronously and started on load
(
new window.VLibras.Widget('https://vlibras.gov.br/app')), with a guard so it loads only once per page. - The widget appears on the pages that show the sidebar; a theme without a sidebar shows no block plugin.
- No core files are changed and no database schema is added; disabling the plugin removes the widget entirely.
Privacy / availability note. The widget is served from
vlibras.gov.br(Brazilian government), which currently redirects to the jsDelivr CDN. Enabling this plugin makes readers' browsers load that third-party script; a site with a Content Security Policy must allowvlibras.gov.brandcdn.jsdelivr.net. If the service is unavailable, the avatar simply does not appear.
-
PHPUnit (
tests/*Test.php, onPKP\tests\PKPTestCase): the plugin class against the installed PKP, the plugin found by PKP's plugin registry, the loader queued for reader pages only, a template without scripts and with escaped text, the loader talking only to the official widget, and the translations. From the OJS root:lib/pkp/lib/vendor/bin/phpunit --configuration lib/pkp/tests/phpunit.xml --no-coverage "$PWD/plugins/blocks/vlibras/tests"(On OJS 3.3 the PHPUnit configuration is
lib/pkp/tests/phpunit-env1.xml.) -
Cypress (
cypress/tests/functional/VLibrasBlock.cy.js, run by pkp-github-actions on every push to the 3.5 and 3.4 branches): enables the plugin and places the block in the sidebar, then checks as a reader that the block shows once, the loader is printed once and outside the block, the VLibras button appears and pressing it opens the translator (it fails when the loader is not queued). The sidebar is put back after the run. -
Verified on OJS 3.5.0.3, 3.4.0.10 and 3.3.0.22.
Tests are kept in the repository and are not part of the release package.
- VLibras is developed by the Brazilian Government (Ministério da Gestão e da Inovação em Serviços Públicos / LAViD-UFPB) and distributed by them; this plugin only embeds their public widget.
- This OJS integration plugin is developed and maintained by OJSBR and distributed under the GNU GPL v3.
Generative AI (Claude, by Anthropic) was used to write and run tests, improve the code and bring it in line with PKP standards. Every change is reviewed and tested by OJSBR, which is responsible for the published releases.
Issues and pull requests are welcome. Please target the branch matching the OJS version you
are working against. See CONTRIBUTING.md.
This integration plugin is distributed under the GNU GPL v3. See LICENSE and
docs/COPYING. VLibras itself is subject to its own licensing by the Brazilian government.
Um plugin de bloco para o Open Journal Systems (OJS) que incorpora o widget oficial do VLibras — o tradutor de Português para Libras (Língua Brasileira de Sinais) do governo federal, com o avatar 3D flutuante — para que leitores surdos possam traduzir o conteúdo da revista. Sem alterar o núcleo do OJS.
Desenvolvido e mantido pela OJSBR. O VLibras em si é um produto do governo brasileiro (veja Créditos).
| Versão do OJS | Branch | Release do plugin |
|---|---|---|
| OJS 3.5.x | stable-3_5_0 (padrão) |
1.0.1.1 |
| OJS 3.4.x | stable-3_4_0 |
1.0.1.1-ojs3.4 |
| OJS 3.3.x | stable-3_3_0 |
1.0.1.1-ojs3.3 |
Para muitos leitores surdos no Brasil a primeira língua é a Libras, não o português escrito. O governo federal oferece de graça um widget que traduz o texto da página para Libras com um avatar 3D, mas colocá-lo numa revista exige mexer nos templates do tema.
- Carrega o widget oficial do VLibras de
https://vlibras.gov.br/app, exibindo o avatar de Libras flutuante em todas as páginas públicas da revista. - O leitor clica no avatar e seleciona o texto para vê-lo traduzido em Libras.
- Traz um pequeno bloco rotulado para a barra lateral, para o editor posicionar e descrever.
- Título e texto do bloco traduzidos em 38 idiomas (33 no OJS 3.3, cuja lista de idiomas é menor); o widget em si traduz o conteúdo em português para Libras.
Instale em Configurações → Website → Plugins → Enviar um novo plugin, ou extraia a pasta
em plugins/blocks/ (ficando plugins/blocks/vlibras/). Ative o Bloco VLibras (Libras) na
lista de plugins de Bloco e posicione o bloco em Configurações → Website → Aparência →
Barra lateral.
- Um
BlockPluginrenderizatemplates/block.tple enfileirajs/vlibras.jsnas páginas do leitor (addJavaScript, impresso no fim da página). O template não tem script. - O carregador cria a marcação oficial do VLibras (
<div vw>…) como filho direto de<body>, como na documentação do VLibras, para que o avatar flutuante não sofra efeito do CSS da barra lateral. - O script do widget é carregado de forma assíncrona e iniciado no
onload(new window.VLibras.Widget('https://vlibras.gov.br/app')), com uma guarda para carregar só uma vez por página. - O widget aparece nas páginas que mostram a barra lateral; tema sem barra lateral não exibe plugin de bloco.
- Nenhum arquivo do núcleo é alterado e nenhum schema de banco é adicionado; desativar o plugin remove o widget por completo.
Nota de privacidade / disponibilidade. O widget é servido por
vlibras.gov.br(governo brasileiro), que hoje redireciona para o CDN jsDelivr. Ativar este plugin faz o navegador dos leitores carregar esse script de terceiros; site com Content Security Policy precisa liberarvlibras.gov.brecdn.jsdelivr.net. Se o serviço estiver indisponível, o avatar simplesmente não aparece.
PHPUnit em tests/ (sobre PKP\tests\PKPTestCase) e Cypress em cypress/tests/functional/
(rodado pelo pkp-github-actions a cada push nas
branches 3.5 e 3.4), com os comandos da seção em inglês (no OJS 3.3 com lib/pkp/tests/phpunit-env1.xml). A suíte cobre
a classe contra o PKP instalado, o plugin encontrado pelo registro de plugins, o carregador
enfileirado só nas páginas do leitor, o template sem script e com texto escapado, o carregador
falando só com o widget oficial e as traduções. O Cypress liga o plugin, põe o bloco na barra
lateral e confere, como leitor, que o bloco aparece uma vez, o carregador sai uma vez e fora do
bloco, o botão do VLibras aparece e abre o tradutor (falha sem o carregador); a barra lateral volta
ao que era no fim. Verificado no OJS 3.5.0.3, 3.4.0.10 e 3.3.0.22.
Os testes ficam no repositório e não fazem parte do pacote da release.
- O VLibras é desenvolvido pelo Governo Brasileiro (Ministério da Gestão e da Inovação em Serviços Públicos / LAViD-UFPB) e distribuído por ele; este plugin apenas incorpora o widget público.
- Este plugin de integração com o OJS é desenvolvido e mantido pela OJSBR e distribuído sob a GNU GPL v3.
Foi usada IA generativa (Claude, da Anthropic) para escrever e rodar testes, melhorar o código e alinhá-lo aos padrões da PKP. Toda mudança é revisada e testada pela OJSBR, que responde pelas releases publicadas.
Este plugin de integração é distribuído sob a GNU GPL v3. Veja LICENSE e
docs/COPYING. O VLibras em si está sujeito ao licenciamento próprio do governo brasileiro.