Add supplementary material validations for SPS 1.10 by Copilot · Pull Request #1129 · scieloorg/packtools

Copilot · 2026-03-13T14:17:47Z

O que esse PR faz?

Implementa validações para <supplementary-material> e <sec sec-type="supplementary-material"> conforme SPS 1.10, cobrindo 7 de 10 regras (70%):

Regra	Validação	Nível
1	`@id` em `<supplementary-material>`	CRITICAL
2	`<label>` em `<supplementary-material>` (fix: usava label do media)	CRITICAL
3	`<title>` em `<sec sec-type="supplementary-material">`	CRITICAL
4	Proibição de `<inline-supplementary-material>`	ERROR
5	Presença de `<graphic>` ou `<media>`	WARNING
7	Unicidade de `@id`	ERROR

Corrige bug no modelo onde media.data sobrescrevia o label do <supplementary-material> — novo campo suppl_label preserva o valor original. Corrige teste test_validate_full_workflow que falhava por None em resultados de validação.

Onde a revisão poderia começar?

packtools/sps/validation/supplementary_material.py — contém toda a lógica de validação nova.

Como este poderia ser testado manualmente?

python -m pytest tests/sps/validation/test_supplementary_material.py tests/sps/models/test_supplementary_material.py -v

27 testes (16 validação + 11 modelo), todos passando.

Algum cenário de contexto que queira dar?

Modelo (supplementary_material.py): SupplementaryMaterial.data faz base_data.update(self.media.data) que sobrescreve label/caption com os valores do <media> (geralmente None). Campos suppl_label e suppl_caption foram adicionados para preservar os valores do <supplementary-material>.

Validações que retornam None: Métodos como validate_transcript() em accessibility_data.py retornam None para casos não aplicáveis. O xml_validator.py já filtra com if not item: continue. O teste test_validate_full_workflow foi corrigido para seguir o mesmo padrão.

Screenshots

N/A

Quais são tickets relevantes?

N/A

Referências

SPS 1.10 — Supplementary Material

Original prompt

This section details on the original issue you should resolve

<issue_title>Criar validações para o elemento </issue_title>
<issue_description>## Objetivo

Implementar validações para o elemento <supplementary-material> e a seção <sec sec-type="supplementary-material"> conforme a especificação SPS 1.10, aumentando a conformidade de X% para 70% (7 de 10 regras).

Nota: Algumas validações para <supplementary-material> podem já estar parcialmente implementadas no repositório. Este Issue visa reavaliar, complementar e garantir cobertura completa das regras SPS 1.10.

Contexto

Material suplementar corresponde a todo conteúdo enviado separadamente do PDF do documento que complementa o trabalho publicado. No XML, deve ser representado por uma seção <sec sec-type="supplementary-material"> contendo elementos <supplementary-material> individuais. Validações corretas garantem presença de elementos obrigatórios, estrutura adequada, e conformidade com recomendações PMC/JATS.

Conformidade atual: X de 10 regras implementadas (X%)
Meta após implementação: 7 de 10 regras (70%)

Documentação SPS

Referência oficial: https://docs.google.com/document/d/1GTv4Inc2LS_AXY-ToHT3HmO66UT0VAHWJNOIqzBNSgA/edit?tab=t.0#heading=h.supplementarymaterial

Regras principais conforme SPS 1.10:

Ocorrência:
- <supplementary-material> pode aparecer zero ou mais vezes em <sec> e <article-meta>
- <sec sec-type="supplementary-material"> deve ser a última seção de <body> ou aparecer em <back>
Atributos obrigatórios:
- @sec-type="supplementary-material" em <sec> (obrigatório)
- @id em <supplementary-material> (obrigatório)
- Atributos em <media>: @id, @mime-type, @mime-subtype, @xlink:href (obrigatórios)
- Atributo em <graphic>: @xlink:href (obrigatório)
Elementos obrigatórios:
- <sec sec-type="supplementary-material"> requer <title> (obrigatório)
- <supplementary-material> requer <label> (obrigatório)
Estrutura:
- Seção <sec sec-type="supplementary-material"> como container
- Um elemento <supplementary-material> para cada item suplementar
- Dentro de <supplementary-material>:
  - <graphic> para figuras
  - <media> para outros tipos (PDF, Word, Excel, vídeo, etc.)
Elementos opcionais:
- <caption> com <title> (opcional em <supplementary-material>)
Restrições:
- Proibido: uso de <inline-supplementary-material>
Regras de links externos:
- Links externos não dispensam envio do arquivo no pacote
- Arquivo deve estar no pacote e marcado como <supplementary-material>
- Link pode ser mantido como <ext-link> adicional no texto
Distinções importantes:
- Dataset: não é material suplementar → Declaração de Disponibilidade de Dados
- Conteúdo no PDF: não é material suplementar → marcar com elemento semântico apropriado
- Apêndice/Anexo: usar <app-group> e <app>, não material suplementar

Regras a Implementar

P0 – Críticas (implementar obrigatoriamente)

#	Regra	Nível	Descrição
1	Validar presença de `@id` em `<supplementary-material>`	CRITICAL	O atributo `@id` é obrigatório em `<supplementary-material>`
2	Validar presença de `<label>` em `<supplementary-material>`	CRITICAL	O elemento `<label>` é obrigatório em cada `<supplementary-material>`
3	Validar presença de `<title>` em `<sec sec-type="supplementary-material">`	CRITICAL	O elemento `<title>` é obrigatório em `<sec sec-type="supplementary-material">`
4	Validar ausência de `<inline-supplementary-material>`	ERROR	O uso de `<inline-supplementary-material>` não é permitido

P1 – Importantes (implementar se possível)

#	Regra	Nível	Descrição
5	Validar presença de conteúdo (`<graphic>` ou `<media>`)	WARNING	`<supplementary-material>` deve conter `<graphic>` (para figuras) ou `<media>` (para outros tipos)
6	Validar presença de `<sec sec-type="supplementary-material">` quando há `<supplementary-material>`	WARNING	Materiais suplementares devem estar dentro de `<sec sec-type="supplementary-material">`
7	Validar unicidade de `@id` em `<supplementary-material>`	ERROR	Cada `<supplementary-material>` deve ter um `@id` único

P2 – Futuras (fora do escopo deste Issue)

#	Regra	Motivo de exclusão
8	Validar que arquivo existe no pacote	Alta complexidade - requer acesso ao sistema de arquivos
9	Validar posicionamento (última seção de body ou em back)	Média complexidade - requer análise de ordem de elementos irmãos
10	Validar que conteúdo não é dataset	Alta complexidade - requer análise semântica de conteúdo

Arquivos a Criar/Modificar

Avaliar existentes (podem ter validações parciais):

`packtoo...

Fixes Criar validações para o elemento <supplementary-material> #1111

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@id

- Add validate_id: @id presence in supplementary-material (CRITICAL) - Add validate_sec_title: <title> in sec (CRITICAL) - Add validate_content: <graphic>/<media> presence (WARNING) - Add validate_id_uniqueness: unique @id values (ERROR) - Update inline error level from CRITICAL to ERROR - Fix validate_label to use suppl_label (preserved from model) - Add suppl_label, suppl_caption, has_content to model data - Update rules JSON with new error level configs - Rewrite tests: 16 tests covering all validations Co-authored-by: robertatakenaka <505143+robertatakenaka@users.noreply.github.com>

Co-authored-by: robertatakenaka <505143+robertatakenaka@users.noreply.github.com>

Initial plan

ab46e81

Copilot AI assigned Copilot and robertatakenaka Mar 13, 2026

Copilot started work on behalf of robertatakenaka March 13, 2026 14:17 View session

Copilot AI and others added 2 commits March 13, 2026 14:34

Fix f-string without interpolation in validate_id_uniqueness

c7cb5a4

Co-authored-by: robertatakenaka <505143+robertatakenaka@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Implement validations for supplementary-material element~~ Add supplementary material validations for SPS 1.10 Mar 13, 2026

Copilot AI requested a review from robertatakenaka March 13, 2026 14:37

Copilot finished work on behalf of robertatakenaka March 13, 2026 14:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add supplementary material validations for SPS 1.10#1129

Add supplementary material validations for SPS 1.10#1129
Copilot wants to merge 3 commits intomasterfrom
copilot/create-validations-supplementary-material

Copilot AI commented Mar 13, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Copilot AI commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

O que esse PR faz?

Onde a revisão poderia começar?

Como este poderia ser testado manualmente?

Algum cenário de contexto que queira dar?

Screenshots

Quais são tickets relevantes?

Referências

Contexto

Documentação SPS

Regras principais conforme SPS 1.10:

Regras a Implementar

P0 – Críticas (implementar obrigatoriamente)

P1 – Importantes (implementar se possível)

P2 – Futuras (fora do escopo deste Issue)

Arquivos a Criar/Modificar

Avaliar existentes (podem ter validações parciais):

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Mar 13, 2026 •

edited

Loading