Skip to content

[xml validation] mudar o que a checagem questiona quando encontra um Resumo num tipo que não o prevê. #1290

Description

@robertatakenaka

Mudar o que a checagem questiona quando encontra um Resumo num tipo que não o prevê.

Atualmente (StandardAbstractsValidation.validate_exists() em packtools/sps/validation/article_abstract.py, ramo article_type_unexpects):

  • Resumo presente é CRITICAL.
  • Mensagem: "Abstract is not expected for {article_type}".
  • Conselho implícito: remover o Resumo.

Proposto:

  • Resumo presente num @article-type de article_type_unexpects passa a ser ERRO (não WARNING porque o usuário não verifica e o problema pode ser propagado nas métricas).
  • Mensagem passa a sugerir a revisão do @article-type, não a remoção do Resumo: a presença do Resumo é o sinal de que o tipo declarado pode não ser o mais adequado à estrutura do documento, e não um defeito do Resumo em si.
  • Ausência de Resumo nesses tipos continua válida (comportamento atual mantido).

Isso não exige tocar nas listas article_type_requires/article_type_unexpects/article_type_neutral de abstract_rules.json; o article_type_requires (Resumo ausente onde é exigido) fica fora deste escopo.


o problema não é a lista de tipos, é a direção da checagem. Hoje, quando o packtools encontra um Resumo num tipo que não o prevê, ele aponta o Resumo como o erro. Faz mais sentido apontar o @article-type como o que precisa de revisão.

Pra focar só no que muda, segue a mesma matriz da comparação anterior, reduzida às linhas em que o packtools diverge do critério proposto (coluna "Alinhamento" da matriz completa, acima):

@article-type Critério proposto packtools hoje
article-commentary recomendado dispensável
brief-report obrigatório dispensável
rapid-communication obrigatório dispensável
clinical-instruction obrigatório dispensável
discussion recomendado dispensável
editorial recomendado dispensável
article-commentary recomendado dispensável

As duas linhas article-commentary correspondem a "comentário de artigo" e "posicionamento ou pensamento coletivo" na matriz original; o packtools usa o mesmo @article-type pros dois.

Em todas essas linhas, o packtools hoje classifica o tipo como "dispensável" (ou seja, está em article_type_unexpects), mas o critério proposto pede pelo menos "recomendado", e em 3 casos (brief-report, rapid-communication, clinical-instruction) pede "obrigatório". É justamente nesses tipos que a mudança de direção da checagem (Resumo presente sinaliza revisão do tipo, não remoção do Resumo) faz diferença prática.

Referência

#1289

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions