SciELO Publishing Schema - Guia de uso dos elementos e atributos para documentos em XML

Versão 1.3 - setembro de 2015.

Versões anteriores:

Introdução

Este guia de uso descreve o estilo de marcação adotado pelo projeto SciELO para a submissão de documentos no formato XML.

A especificação SciELO Publishing Schema — também chamada SciELO PS — é composta pela especificação NISO JATS Journal Publishing DTD na versão 1.0 mais o Estilo SciELO, que são regras que especializam aspectos da especificação JATS Publishing. Os usuários deste guia devem possuir conhecimentos prévios sobre XML e familiaridade com DTD.

As dúvidas e comentários sobre a especificação SciELO PS, sobre este guia de uso ou sobre as ferramentas disponibilizadas pelo SciELO para apoiar a marcação em XML são tratadas na lista de discussão scielo-xml.

Notas da versão

Novas versões serão disponibilizadas em um calendário fixo, a cada seis meses. Versões de correção serão disponibilizadas sob demanda, e serão identificadas no terceiro dígito identificador da versão. e.g.: versão 1.1.1.

Duas versões são suportadas simultaneamente, a mais recente e a imediatamente anterior. Essa medida garante um ciclo de vida de 1 ano para cada versão. Por suportar entenda manter a documentação, ferramentas de apoio, ingresso no processo de submissão e comunidade de usuários.

Ferramentas de apoio

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

  • Markup: Macro para Microsoft Word que apoia o processo de marcação de documentos, de acordo com a DTD PMC.
  • Stylechecker: Ferramenta baseada na web que apresenta relatório detalhado sobre a conformidade de um dado XML em relação à especificação SciELO PS.
  • Packtools: Biblioteca Python que agrega funcionalidades e utilitários para a manipulação de pacotes SciELO PS e XMLs SciELO PS.
  • Package Maker: Ferramenta para a geração de pacotes SciELO PS e PMC (Windows apenas). Adicionalmente, relatórios detalhados sobre a estrutura e a validade de alguns metadados dos documentos XML também são gerados como subproduto da geração dos pacotes.

Metadados dos periódicos

Adicionalmente, diversos metadados dos periódicos necessários para a identificação de elementos em <journal-meta> estão disponíveis em uma listagem no formato csv, que pode ser baixada aqui. Esta listagem é atualizada semanalmente, às terças-feiras.

Convenções utilizadas neste guia

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

Nota

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

Itálico
Utilizado para nomes de arquivos, normas, URLs, referências ativas a elementos do XML (hiperlinks) ou para introduzir novos termos.
Negrito
Utilizado para identificar textos que devem ser substituídos por valores fornecidos pelo usuário.
Largura fixa
Utilizado para exemplos, trechos ou referências estáticas a elementos ou atributos do XML.

Para cada elemento descrito, há uma lista de definições no formato:

Aparece em
  <journal-meta>

Atributos obrigatórios
  @journal-id-type

Ocorre
  Uma vez

Onde:

  • Aparece em: Apresenta o contexto (elemento-pai) onde o elemento em foco é comumente identificado. O fato de um determinado contexto não constar nesta lista não o exclui automaticamente, e a especificação JATS Publishing deve ser consultada.
  • Atributos obrigatórios: Apresenta apenas os atributos onde, no caso da presença do elemento, devem ser marcados obrigatoriamente. Esta definição pode vir acompanhada de seus valores, também obrigatórios. Caso não existam atributos obrigatórios, este item é omitido.
  • Ocorre: O número de vezes que o elemento pode ocorrer em um contexto.

Lista de elementos

A seguir os elementos do XML que apresentam regras de estilo na especificação SciELO PS. Note que esta não é a lista completa dos elementos XML que compõem o tag set JATS Publishing versão 1.0, e não elimina a necessidade de consultar sua documentação.