Add XMLCrossmarkPipe for Crossref XML with crossmark support#321
Draft
Add XMLCrossmarkPipe for Crossref XML with crossmark support#321
Conversation
Co-authored-by: robertatakenaka <505143+robertatakenaka@users.noreply.github.com>
Co-authored-by: robertatakenaka <505143+robertatakenaka@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add XML generation for Crossref with Crossmark
Add XMLCrossmarkPipe for Crossref XML with crossmark support
Mar 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
O que esse PR faz?
Implementa o elemento
<crossmark>na geração de XML para Crossref, permitindo que artigos SciELO registrem histórico de atualizações (errata, retratações, correções etc.) conforme o protocolo Crossmark.Novos componentes:
CROSSMARK_UPDATE_TYPES— constante com os 12 tipos reconhecidos pelo Crossref:addendum,clarification,correction,corrigendum,erratum,expression_of_concern,new_edition,new_version,partial_retraction,removal,retraction,withdrawalXMLCrossmarkPipe— novo pipe que:CROSSMARK_POLICY(env var) não está definida<crossmark_version>1</crossmark_version><crossmark_policy>a partir da env varCROSSMARK_POLICY<crossmark_domains>a partir deraw.scielo_domain<updates>a partir do camporelated_articlesno JSON do artigoXMLFundingDataPipe: dados de fomento são inseridos dentro do<crossmark>quando ele existeO pipe foi inserido no pipeline de
export.pyapósXMLPermissionsPipe.Formato de
related_articlesesperado no JSON do artigo:{ "related_articles": [ {"type": "erratum", "doi": "10.1590/erratum-001", "date": "2024-06"}, {"type": "retraction", "doi": "10.1590/retraction-001", "date": "2025-03"} ] }XML gerado:
Onde a revisão poderia começar?
articlemeta/export_crossref.py— classeXMLCrossmarkPipe(adicionada antes deXMLFundingDataPipe).Como este poderia ser testado manualmente?
CROSSMARK_POLICY=https://www.scielo.br/crossmark-policyrelated_articlesno JSON de um artigo (ver formato acima)Export.pipeline_crossref()e verificar a presença e estrutura do elemento<crossmark>Sem
CROSSMARK_POLICYdefinida, o pipe é ignorado e nenhum<crossmark>é gerado.Algum cenário de contexto que queira dar?
O
XMLFundingDataPipejá tinha lógica para detectar e usar o elemento<crossmark>se presente (publisher_item.find("../crossmark")), mas o elemento nunca era criado. Este PR implementa o pipe que faltava.Os dados de artigos relacionados (
related_articles) devem ser populados na camada de ingestão do articlemeta — este PR define o contrato de formato esperado.Screenshots
N/A
Quais são tickets relevantes?
Geração de XML para Crossref com crossmark
Referências
Original prompt
This section details on the original issue you should resolve
<issue_title>Geração de XML para Crossref com crossmark</issue_title>
<issue_description>### Descrição da tarefa
Criar para o formato do xmlcrossref, o elemento crossmark, considerando os campos de histórico e os campos de relacionamento entre outros artigos no json do articlemeta e/ou xylose.Document.
Crossmark – 12 tipos de update (Crossref)
Referência: https://www.crossref.org/documentation/crossmark/
1.
addendumInformação adicional relevante publicada após o artigo original.
2.
clarificationEsclarece ambiguidade ou trecho confuso sem alterar conclusões.
3.
correctionTermo genérico para correção de erro não classificado abaixo.
4.
corrigendumCorreção formal de erros introduzidos pelos autores.
5.
erratumCorreção de erros introduzidos pela editora (tipografia, etc.).
6.
expression_of_concernEditor expressa preocupação com integridade dos dados/metodologia.
7.
new_editionNova edição do trabalho (livro/monografia); substitui a anterior.
8.
new_versionNova versão do registro (preprint → VoR, dataset atualizado, etc.).
9.
partial_retractionRetratação de parte do artigo (seção, figura, experimento).