⬇️ Install package: OMP 3.5 · OMP 3.4 — or browse all Releases.
Registers monograph and chapter DOIs with Crossref and exports the corresponding Crossref book deposit XML (schema 5.3.1).
OMP 3.4/3.5 ships the core DOI framework but — unlike OJS — does not ship a Crossref registration-agency plugin, so a press can assign DOIs and has no way to deposit them.
This plugin fills that gap. It plugs into the native DOI
framework (IDoiRegistrationAgency), so DOIs are assigned and managed from
Settings → Distribution → DOIs and deposited from the DOIs management page, exactly
like in OJS.
Based on PKP's OJS Crossref plugin by Bozana Bokan, Juan Pablo Alperin and James MacGregor (© Simon Fraser University / John Willinsky, MIT License), adapted to the OMP DOI framework and maintained by OJSBR. See the Credits & authorship section below.
| OMP version | Branch | Plugin release |
|---|---|---|
| OMP 3.5.x | stable-3_5_0 (default) |
1.0.0.7 |
| OMP 3.4.x | stable-3_4_0 |
1.0.0.7-omp3.4 |
Tested on OMP 3.5.0.5 and 3.4.0.10. The DOI registration-agency framework is shared by pkp-lib and has the same contract in OMP 3.4 and 3.5, so both branches share the same implementation.
Upgrade from 1.0.0.5 (1.0.0.4 on OMP 3.4). A contributor name made only of blanks in the deposit locale produced an empty
<surname>and Crossref refused the whole deposit; long names could be cut in the middle of a character; every batchtimestampended in000, so two deposits of the same DOI within a second carried the same record version; and five labels and messages borrowed from OJS showed as##key##in OMP (the password field, the missing-requirements notice and the deposit results). All fixed in 1.0.0.6.
- OMP 3.5.x
- A Crossref member account (DOI prefix) and deposit credentials (username/password)
- Monograph (the publication) → Crossref
<book book_type="monograph">; for an edited volume the book is deposited as<book book_type="edited_book">and only the contributors flagged as volume editor are listed at book level, withcontributor_role="editor"(chapter authors stay in their chapters) - Chapter → Crossref
<content_item component_type="chapter">
- Install via Settings → Website → Plugins → Upload A New Plugin, uploading the
crossref.tar.gzpackage; or extract it intoplugins/generic/so you getplugins/generic/crossref/. - Enable Crossref Manager Plugin under the Generic plugins list.
- Go to Settings → Distribution → DOIs. Enable DOIs, set your DOI prefix and choose which content types get DOIs (Monographs and/or Chapters).
- Select Crossref as the Registration Agency and fill in depositor name/email and
your Crossref username/password. Keep Test mode on to validate against
test.crossref.org; turn it off for production deposits todoi.crossref.org. - Make sure a Publisher is set under Settings → Press (Crossref requires it).
From the DOIs management page, assign DOIs to published monographs/chapters and use Deposit (or Export to download the XML). Deposit status and the Crossref response are shown per item.
- Deposit resource URLs point at the OMP catalog:
.../catalog/book/{id}for monographs and.../catalog/book/{id}/chapter/{chapterId}for chapters. - ISBNs are taken from the monograph's publication formats (ONIX ISBN-13/ISBN-10); a
<noisbn reason="monograph"/>is emitted when none are present. - Metadata is exported in the publication's own locale.
- ORCID iDs: the Crossref schema only accepts
https://orcid.org/…. An iD that does not match it is left out of the deposit instead of failing the whole export. ORCID Sandbox iDs (https://sandbox.orcid.org/…, stored when the ORCID integration runs against the sandbox API) are rewritten to the production host while the plugin is in test mode, so the Sandbox → OMP → Crossref workflow can be tested, and are dropped in production, so a sandbox iD is never deposited against a live DOI. Theauthenticatedattribute follows whether the contributor's ORCID was actually verified. - Names: blanks around a name are removed; a contributor with no name in the deposit locale takes the first locale that has one; a given name alone becomes the surname; names are cut to Crossref's 60 characters without breaking a character.
-
PHPUnit (
tests/*Test.php, onPKP\tests\PKPTestCase): the plugin classes against the installed PKP, the plugin found by PKP's plugin registry, the contributors node (blank names, fallback locale, UTF-8 cut, ORCID in production and test mode), chapter pages, the batch timestamp and the 38 translations. From the OMP root:lib/pkp/lib/vendor/bin/phpunit --configuration lib/pkp/tests/phpunit.xml --no-coverage "$PWD/plugins/generic/crossref/tests" -
Cypress (
cypress/tests/functional/CrossrefSettings.cy.js, run by pkp-github-actions on OMP on every push): enables the plugin and checks Crossref offered as the DOI registration agency, with its fields and no untranslated text; nothing else is saved. -
Verified on OMP 3.5.0.5 and 3.4.0.10: the XML of published books with chapters (DOIs set in memory, nothing deposited) validates against the Crossref schema, also as an edited volume (
edited_bookwith the volume editor at book level) and with a surname made of a blank, which failed validation before 1.0.0.6.
Tests are kept in the repository and are not part of the release package.
- Original work: PKP's OJS Crossref export/registration plugin by Bozana Bokan, Juan Pablo
Alperin and James MacGregor (© Simon Fraser University / John Willinsky,
https://github.com/pkp/ojs), distributed under the MIT License, whose notice is kept in
docs/LICENSE-PKP-MIT. - Adaptation to the OMP DOI framework: 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 OMP version you
are working against. See CONTRIBUTING.md.
Distributed under the GNU GPL v3. See LICENSE and docs/COPYING; the MIT notice
of the original PKP plugin is in docs/LICENSE-PKP-MIT.
Plugin Crossref para o Open Monograph Press (OMP): registra DOIs de livros (monografias) e capítulos no Crossref e exporta o XML de depósito de livro (schema 5.3.1).
O OMP 3.4/3.5 traz o framework de DOI, mas — diferente do OJS — não inclui um plugin de
agência Crossref: a editora atribui DOIs e não tem como depositá-los. Este plugin preenche essa
lacuna, integrando-se ao framework nativo (IDoiRegistrationAgency).
Baseado no plugin Crossref do OJS (PKP) de Bozana Bokan, Juan Pablo Alperin e James MacGregor (© Simon Fraser University / John Willinsky, licença MIT), adaptado ao framework de DOI do OMP e mantido pela OJSBR. Veja a seção Créditos e autoria abaixo.
Atualização a partir da 1.0.0.5 (1.0.0.4 no OMP 3.4). Nome de contribuidor feito só de espaços no idioma do depósito gerava
<surname>vazio e o Crossref recusava o depósito inteiro; nomes longos podiam ser cortados no meio de um caractere; otimestampdo lote sempre terminava em000, e dois depósitos do mesmo DOI no mesmo segundo levavam a mesma versão; e cinco textos emprestados do OJS apareciam como##chave##no OMP (campo de senha, aviso de requisitos e resultados do depósito). Tudo corrigido na 1.0.0.6.
| Versão do OMP | Branch | Release do plugin |
|---|---|---|
| OMP 3.5.x | stable-3_5_0 (padrão) |
1.0.0.7 |
| OMP 3.4.x | stable-3_4_0 |
1.0.0.7-omp3.4 |
- Monografia (a publicação) →
<book book_type="monograph">; em obra organizada (volume editado) o livro sai como<book book_type="edited_book">e só os contribuidores marcados como editor de volume entram no nível do livro, comcontributor_role="editor"(os autores ficam nos seus capítulos) - Capítulo →
<content_item component_type="chapter">
- Instale em Configurações → Website → Plugins → Enviar um novo plugin (pacote
crossref.tar.gz) ou extraia emplugins/generic/(ficandoplugins/generic/crossref/) e ative o Crossref Manager Plugin. - Em Configurações → Distribuição → DOIs, habilite DOIs, defina o prefixo, escolha
os tipos de conteúdo, selecione Crossref como agência e preencha depositante e
usuário/senha do Crossref. Mantenha o modo de teste para validar em
test.crossref.org; desative para produção emdoi.crossref.org. - Garanta um Editor (Publisher) em Configurações → Editora, exigido pelo Crossref.
- ORCID: o schema do Crossref só aceita
https://orcid.org/…. Um iD fora desse padrão é omitido do depósito em vez de derrubar o export inteiro. iDs do Sandbox do ORCID (https://sandbox.orcid.org/…, gravados quando a integração ORCID aponta para a API de sandbox) são reescritos para o host de produção enquanto o plugin está em modo de teste, para permitir testar o fluxo Sandbox → OMP → Crossref, e são omitidos em produção, para que um iD de sandbox nunca seja depositado contra um DOI real. O atributoauthenticatedacompanha se o ORCID do contribuidor foi de fato autenticado. - Nomes: espaços em volta do nome são removidos; contribuidor sem nome no idioma do depósito usa o primeiro idioma que tiver; só prenome vira sobrenome; nomes são cortados nos 60 caracteres do Crossref sem quebrar caractere.
PHPUnit em tests/: classes do plugin
contra o PKP instalado, nó de contribuidores (nomes em branco, idioma de recuo, corte UTF-8, ORCID
em produção e em teste), páginas do capítulo, timestamp do lote e as 38 traduções. Verificado no
OMP 3.5.0.5: o XML de três livros publicados com 4 e 5 capítulos (DOIs só em memória, nada
depositado) valida contra o schema do Crossref, também como obra organizada e com sobrenome feito
de um espaço, que reprovava antes da 1.0.0.6. Spec Cypress em cypress/tests/functional/: Crossref
oferecido como agência de registro de DOI, com os campos e nenhum texto sem tradução (nada é salvo);
reprova com as traduções da 1.0.0.5. Tudo verificado também no OMP 3.4.0.10.
A suíte roda sobre PKP\tests\PKPTestCase, também confere que o registro de plugins encontra o plugin, e o Cypress roda no pkp-github-actions no OMP a cada push. Os testes ficam no repositório e não fazem parte do pacote da release.
- Trabalho original: plugin Crossref do OJS (PKP) de Bozana Bokan, Juan Pablo Alperin e
James MacGregor (© Simon Fraser University / John Willinsky, https://github.com/pkp/ojs),
distribuído sob a licença MIT, cujo aviso está em
docs/LICENSE-PKP-MIT. - Adaptação ao framework de DOI do OMP: mantida pela OJSBR e distribuída 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.
Distribuído sob a GNU GPL v3. Veja LICENSE e docs/COPYING; o aviso MIT do
plugin original da PKP está em docs/LICENSE-PKP-MIT.