Guia de uso de elementos e atributos XML para documentos que seguem a implementação SciELO Publishing Schema.

Versão 1.7 - setembro de 2017.

Versões anteriores:

Outros idiomas:

Introdução

Este guia descreve o uso do estilo de marcação adotado pela SciELO para submissão de documentos em formato XML.

A SciELO Publishing Schema (SciELO PS) é composta pelas especificações:

Os usuários deste guia devem possuir conhecimentos prévios de XML e DTD.

Dúvidas e/ou comentários acerca da especificação SciELO PS, deste guia de uso ou das ferramentas disponibilizadas pela SciELO como apoio à marcação em XML devem ser tratadas por meio de lista de discussão scielo-xml.

Notas da versão

As versões são disponibilizadas a cada seis meses em calendário fixo. Versões de correção são disponibilizadas por demanda, sendo identificadas no terceiro dígito da versão. Ex.: versão 1.1.1.

Duas versões são suportadas simultaneamente, a atual e a imediatamente anterior. Essa medida garante um ciclo de vida de 1 (um) ano para cada versão.

Ferramentas de apoio

Algumas ferramentas são disponibilizadas e mantidas pela SciELO seguindo o modelo open source, para apoiar o processo de marcação de documentos em formato XML.

Markup:
Coleção de macros para Microsoft Word para marcação de documentos conforme a SciELO PS.
Stylechecker:
Ferramenta online para verificar se determinado XML está em conformidade com a especificação SciELO PS. Disponível a partir do SciELO Manager.
Packtools:
Biblioteca escrita em Python com funcionalidades e utilitários para manipulação de pacotes e XMLs da SciELO PS.
Package Maker:
Ferramenta para geração de Pacotes SciELO PS e PMC. Adicionalmente, fornece relatórios detalhados sobre a estrutura e a validade de alguns metadados de documentos XML como subproduto do processo de geração.

Metadados de periódicos

Complementarmente, encontra-se disponível em formato csv uma lista de metadados de periódicos necessários para identificação de elementos em <journal-meta>. O documento pode ser baixado a partir deste link e sua atualização é semanal, sempre às quartas-feiras.

Convenções utilizadas neste guia

Para facilitar a compreensão deste guia, foram utilizadas algumas convenções de estilo e formatação.

Formatação

Nota

Estas caixas apresentam informação importante e diretamente relacionada ao contexto em que estão inseridas.

Itálico

Utilizado sempre para:

  • palavras e/ou termos estrangeiros;
  • nomes de publicações, empresas, instituições, projetos, técnicas, tecnologias, marcas etc;
  • nomes de arquivos, normas e referências.

Negrito

Identifica palavras ou termos que devem ser substituídos por conteúdo adequado fornecido pelo usuário.

Fonte monoespaçada

Usado para exemplos, trechos de código e referências estáticas a elementos e atributos do XML.

Será utilizada a linguagem de marcação RST (reStructuredText) para formatar e habilitar recursos de hipertexto aos documentos.

Estruturação

Na descrição dos elementos, devem obrigatoriamente aparecer os seguintes itens, salvo quando especificado em contrário:

  1. Nome do elemento em formato de tag.

    Ex. <article-meta>

  2. Aparece em: apresenta o contexto (elemento-pai) onde o elemento ocorre, podendo ser uma lista.

    Ex. <journal-meta>

  3. Atributos obrigatórios: lista somente os atributos obrigatórios ao elemento descrito. Pode vir acompanhado de valores predefinidos e/ou obrigatórios. Item opcional.

    Ex. @journal-id-type

  4. Ocorre: especifica a quantidade de ocorrências.

    Ex. Uma vez

  5. Descrição do elemento.

  6. Exemplo(s).

  7. Nota(s). (se necessário)

Nota

A especificação NISO JATS Journal Publishing DTD deve ser consultada sempre que houver dúvida em relação a contextualização de elementos.

Lista de elementos

Esta lista compreende apenas os elementos XML do Estilo SciELO PS. A lista completa dos elementos XML que compõem o tag set da JATS nas versões 1.0 e 1.1 devem ser consultadas se necessário.

Índices e tabelas