Guia de uso de elementos e atributos XML para documentos que seguem a implementação SciELO Publishing Schema.¶
Versão 1.9 - março de 2019.
Versões anteriores:
- Versão 1.8 (suportada).
- Versão 1.7
- Versão 1.6.
- Versão 1.5.
- Versão 1.4.
- Versão 1.3.
- Versão 1.2.
- Versão 1.1.
- Versão 1.0.
Outros idiomas:
- SciELO Publishing Schema Documentation, Version 1.5.1 (PDF in English).
- SciELO Publishing Schema, Versión 1.5 (PDF en español).
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:
- NISO JATS Journal Publishing DTD 1.1;
- Estilo SciELO PS com regras especializadas da Metodologia SciELO.
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 doze 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 2 (dois) anos para cada versão.
- O que há de novo na SciELO PS 1.9
- O que há de novo na SciELO PS 1.8
- O que há de novo na SciELO PS 1.7
- O que há de novo na SciELO PS 1.6
- O que há de novo na SciELO PS 1.5
- O que há de novo na SciELO PS 1.4
- O que há de novo na SciELO PS 1.3
- O que há de novo na SciELO PS 1.2
- O que há de novo na SciELO PS 1.1
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.
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:
Nome do elemento em formato de tag.
Ex.
<article-meta>
Aparece em: apresenta o contexto (elemento-pai) onde o elemento ocorre, podendo ser uma lista.
Ex.
<journal-meta>
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
Ocorre: especifica a quantidade de ocorrências.
Ex. Uma vez
Descrição do elemento.
Exemplo(s).
Nota(s). (se necessário)
Nota
A especificação NISO JATS Journal Publishing deve ser consultada sempre que houver dúvida em relação a contextualização de elementos.
Documentação narrativa¶
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.
- <abbrev-journal-title>
- <abstract>
- <ack>
- <addr-line>
- <aff>
- <alternatives>
- <app>
- <article>
- <article-categories>
- <article-id>
- <article-meta>
- <article-title>
- <attrib>
- <author-notes>
- <award-group>
- <award-id>
- <back>
- <body>
- <boxed-text>
- <caption>
- <chapter-title>
- <city>
- <collab>
- <comment>
- <conf-date>
- <conf-loc>
- <conf-name>
- <contrib>
- <contrib-group>
- <contrib-id>
- <copyright-holder>
- <copyright-statement>
- <copyright-year>
- <corresp>
- <country>
- <counts>
- <data-title>
- <date>
- <date-in-citation>
- <day>
- <def-list>
- <disp-formula>
- <disp-quote>
- <edition>
- <element-citation>
- <elocation-id>
- <email>
- <etal>
- <ext-link>
- <fig>
- <fn>
- <fn-group>
- <fpage>
- <front>
- <front-stub>
- <funding-group>
- <funding-source>
- <funding-statement>
- <given-names>
- <glossary>
- <history>
- <inline-formula>
- <inline-graphic>
- <inline-supplementary-material>
- <institution>
- <institution-id>
- <isbn>
- <issn>
- <issue>
- <journal-id>
- <journal-meta>
- <journal-title>
- <journal-title-group>
- <kwd>
- <kwd-group>
- <label>
- <license>
- <list>
- <lpage>
- <media>
- <mixed-citation>
- <month>
- <name>
- <on-behalf-of>
- <p>
- <page-range>
- <patent>
- <permissions>
- <person-group>
- <postal-code>
- <prefix>
- <product>
- <pub-date>
- <pub-id>
- <publisher>
- <publisher-loc>
- <publisher-name>
- <ref>
- <ref-list>
- <related-article>
- <response>
- <role>
- <season>
- <sec>
- <sig-block>
- <size>
- <source>
- <state>
- <sub-article>
- <subj-group>
- <suffix>
- <supplementary-material>
- <surname>
- <table>
- <table-wrap>
- <table-wrap-foot>
- <title-group>
- <trans-abstract>
- <trans-title>
- <trans-title-group>
- <verse-group>
- <version>
- <volume>
- <xref>
- <year>