Git Product home page Git Product logo

scielo_publishing_schema's Introduction

scielo_publishing_schema's People

Contributors

aline-cristina avatar asael-silva avatar carolinatanigushi avatar ednilson avatar fabiobatalha avatar francine-curivil avatar gustavofonseca avatar jamilatta avatar javani avatar jenniferamato avatar leticiaquino avatar renatogaldino avatar robertatakenaka avatar rpostalli avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

scielo_publishing_schema's Issues

Questão contratual, evitar ambiguidades ou obrigatoriedade inconsistente

Tendo em vista que a norma é referenciada em contratos, o acesso a cada subversão (no caso a v1.1.0) precisa ser preservado. Justamente por isso, sugere-se revisar o texto sobre versões suportadas, algo como acrescentar o texto "subversões não são obrigatórias, mas recomenda-se o upgrade quando não houver conflito contratual na adoção da subversão".

No presente caso da v1.1.1 parece que houve upgrade dos valores permitidos no atributo publication-type: como o upgrade não pode agir retroativamente sobre o contrato de um fornecedor, não se pode obrigar a mudança das práticas já adotadas e aceitas anteriormente (v1.1.0), pode-se apenas recomendar que mude.


Duas versões são suportadas simultaneamente, a mais recente (e.g. v1.1) e a imediatamente anterior (e.g. v1.0). [...].
Subversões não são obrigatórias, mas recomenda-se o upgrade quando não houver conflito contratual na adoção da subversão.

Erro em exemplo de <sig-block>

Pesquisando na JATS notei que o exemplo 2 da tag <sig-block> esta incorreta. Deve-se retirar a informação de parágrafo <p>, pelo que percebi dentro de <sig> não pode usar <p>.

Tornar *journal-id[@journal-id-type="publisher-id"]* obrigatório

Em discussão com @leticiaquino e @RPostalli sobre tornar o atributo citado obrigatório e permitir a presença também do tipo nlm-ta apenas quando o periódico possui.

A seguir está o email que teve a sugestão aprovada:

Sim, eu sei da necessidade do título abrev. do PubMed para os periódicos que são exportados para lá. A preocupação de simplificar a conferência impedindo que sejam colocados outros tipos de identificadores (DOAJ, DOI e outros) também me parece justa. Mas recentemente disponibilizamos uma tabela que contém esses metadados para todos os periódicos, e numa situação onde o artigo sendo produzido possua o valor de “nlm-ta”, o acrônimo não pode ser identificado. 

MInha sugestão é que o acrônimo sempre seja identificado (até pq é a maneira mais eficiente de a gente identificar um periódico internamente), e o “nlm-ta” seja opcional. Quando um artigo for exportado para o PubMed, o sistema deve incluir o valor de "nlm-ta” automaticamente, pq o sistema conhece esse valor.

O que vcs acham? 

-Gustavo

Inserir elemento *response*

  • Se //response/@response-type == reply, então /article/@article-type == article-commentary.

Os valores de //response/@response-type podem ser:

  • addendum
  • discussion
  • reply

Informação sobre o artigo comentado deve ser inserida no elemento related-article/@related-article-type="commentary-article", conforme exemplo:

<response>
    ...
    <front-stub>
        ...
        <related-article related-article-type="commentary-article" id="r01" vol="109" page="87-92"/>
        <counts>...</counts>
        ...
    </front-stub>
    ...
</response>

Em related-article, é obrigatória a presença do atributo @page ou @elocation-id.

Ambiguidade na regra do namespace *mml* no elemento *article*

Na referência do elemento <article> há o parágrafo:
O atributo @xmlns:mml="http://www.w3.org/1998/Math/MathML" é opcional e deve ser utilizado apenas quando equações MathML forem identificadas no documento.

O problema é que a palavra apenas sugere que o namespace não pode ser declarado quando não houverem equações MathML, e isso não é verdade.

Inserir documentos do tipo *errata*

  • O valor do atributo /article/@article-type deve ser correction
  • O texto do elemento //subj-group[@subj-group-type="heading"]/subject deve refletir o sumário do fascículo 👍
  • A errata deve possuir um elemento related-article especificando qual o documento que está sendo ratificado, conforme o exemplo:
...
<article-meta>
  ...
  <permissions>...</permissions>
  <related-article related-article-type="corrected-article" vol="47" page="462" id="RA1" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="10.1590/0037-8682-0064-2014" ext-link-type="doi"/>
  ...
</article-meta>
...
  • O documento corrigido deve possuir uma nota de rodapé, conforme o exemplo:
...
<back>
  ...
  <fn-group>
    <fn fn-type="other">
      <label>Erratum</label>
      <p>Texto da errata</p>
    </fn>
  </fn-group>
  ...
</back>
...

Identificar *funding-source* e *award-id* também na fonte

O XML a seguir ilustra a proposta:

...
<front>
  ...
  <article-meta>
    ...
    <funding-group>
      <award-group>
        <funding-source rid="01">CNPq</funding-source>
        <award-id rid="02">16362 2010/2011</award-id>
      </award-group>
    </funding-group>
    ...    
  </article-meta>
  ...
</front>
...
<back>
  <ack>
    <title>ACKNOWLEDGEMENTS</title>
    <p>The authors acknowledge the support of <funding-source id="01">CNPq</funding-source>-PIBIC for Scientific Initiation scholarship (Process number <award-id id="02">16362 2010/2011</award-id>) granted to carry out this research.</p>
  </ack>
</back>
...

A justificativa é de simplificar o processo de validação destes metadados, podendo ser implementado em Schematron e distribuído junto com as demais validações. (acho que preciso melhorar essa justificativa... )

obrigatoriedade de xref do tipo aff em <contrib-group>

Necessitamos inserir uma nota na tag de (http://docs.scielo.org/projects/scielo-publishing-schema/pt_BR/1.1-branch/tagset.html#contrib-group), dizendo que a a tag xref do tipo aff é obrigatória (mesmo que fechada sem label).

Decisão tomada segundo observações de Roberta e Javani que afirmam que este dados é importante para levantamento de dados par a SciELO, conforme insiro a seguir:

"Com relação rid em aff. Se há afiliação deve haver xref para que seja possível fazer o vínculo entre o autor e sua afiliação correspondente.
Nesse caso, deveria aparecer da seguinte forma: , sem label. Temos que documentar no schema. Javani"

"Temos que avaliar as nossas necessidades na geração dos índices.
No exemplo mesmo que você colocou, imagino que haja um autor para cada afiliação, mas quando retiramos dados não temos como cruzar as informações pela ordem em que os mesmos aparecem no artigo (aff1 ao autor 1, aff2 ao autor 2 etc).
Outra coisa refere-se a segunda afiliação do autor que é perdida no caso de haver mais de uma.
Nos critérios foi explicitado que se há mais de uma afiliação, cada um deve vir em linhas diferentes e temos que ver como cobrar isso, mas não podemos perder este dado de vista uma vez que estamos deixando de atribuir a produção científica a uma instituição específica. Roberta"

Alterações realizadas na documentação 1.1

As alterações realizadas na documentação 1.1 foram:

  • Alteração no nome "Regra de Atribuição..." para "Sugestão de atribuição..";
  • Atributo @Country="" passa a ser obrigatório;
  • Correção em exemplo de <app>. (Estava apresentando o id em , quando deveria estar em <app>);
  • Retirado <p> de <sig>;
  • Inserido mais 2 tipos de "fn" (presented-by e presented-at);
  • Inserido mais 1 tipo de ref (other);
  • Inserido <title> para <abstract>, <trans-abstract>, Referências e keywords (foi add uma informação de que deve conter <title>);
  • Inserido uma nota em <fig> para fonte em imagens;
  • Alteração na informação "Os valores de dia, mês e ano devem ser representados...";
  • Adicionado exemplo de seção com número;
  • Alterado informação "Aparece em" de <funding-source> e <award-id>;
  • Correção na ref "Situação de saúde e grau de dependência de pessoas idosas...". Foi retirado @xml:lang="" de <article-title>;
  • Adicionado documentação de elemento <response>, <sub-article>, <verse-group>, <front-stub>, <boxed-text>;
  • Alteração em todos os exemplos que apresentavam a tag <country> para a tag com atributo: <country country="SIGLA">;
  • Alteração em todos os exemplos que apresentavam o valor "sps-1.1" para "sps-1.2"
  • Adicionado modelo de referência bibliográfica incompleta.

Mudança no item Regra de Nomeação de Imagens

Acredito que o título desta seção no guia deveria abranger todas as regras de nomeação, incluindo a nomeação da pasta principal e de arquivos traduzidos (já que esse nomeação interfere no processamento dos pacotes via FTP).

http://docs.scielo.org/projects/scielo-publishing-schema/pt_BR/latest/tagset.html#regra-de-nomeacao-de-imagens

  • Alterar nome da seção para: Sugestões:
    "Regras de Nomeação" ou "Regras de Nomeação de Arquivos"
  • Acrescentar textos como: Sugestões:

Para a SciELO a construção DA PASTA principal é baseada na seguinte forma: ISSN da revista, acrônimo minúsculo, volume e número, separados por hífen. Exemplo de nome da pasta do Pacote: 1983-3083-refuem-24-03. Com suplemento: 1415-4714-rlpf-17-03-s1

Arquivos com tradução: ISSN-Acrônimo-volume-número-páginafinal-sigladalínguatraduzida

Exemplos:
1983-3083-refuem-24-03-0316-gf01-pt
1983-3083-refuem-24-03-0316-gt01-pt
1983-3083-refuem-24-03-0316-suppl01-pt

OBS: As imagens só devem ter seu nome traduzido (-pt, -en, -es e etc.) como mostra o exemplo acima se algum item da imagem de fato for traduzido. Caso não seja, utilize o mesmo nome sem tradução, pois a imagem seria a mesma do PDF em inglês e do PDF em português. Não utilize ponto (.) e nem underline (_) para nomeação.

Detalhe, faltando talvez link para a versão 1.1.0, e "o que há de novo na 1.1.1"

No texto introdutório falta o link para a 1.1.0 e talvez complementar com as release notes da v1.1.1.
Sugere-se também adicionar exemplos de numeração de versão.


Novas versões (e.g. v1.1) serão disponibilizadas em um calendário fixo, [...]

Duas versões são suportadas simultaneamente, a mais recente (e.g. v1.1) e a imediatamente anterior (e.g. v1.0). [...].

Classificar referências incompletas

Referências do tipo journal deve apresentar, no mínimo, os elementos:

  • journal:
    • element-citation/person-group[person-group-type="author"]/name[1]/surname
    • article-title
    • source
    • year

Caso a referência não apresente esses elementos, esta deve ser classificada com o atributo element-citation/@specific-use="display-only".

formatação do tag: <glossary> na documentação

A tag: não tem a formatação das outras tags aonde aparece claramente:

  • aparece em
  • ocorre
  • atributos obrigatorios

Em lugar disso, essa informação aparece de forma mais ou menos confusa numa nota, que também é confusa:

Glossário em <back> deve ser inserido em backapp-groupappglossary. Para esse caso, é obrigatório inserir um ID para <app>.

No exemplo: Exemplo sub-glossário: não aparece nenhum tag <glossary>

Não identificar algumas tags para *ahead of print*

Descrição

Eu (@leticiaquino) estava pensando se no balaio é possível não identificarmos algumas tags para Ahead Of Print. No processo atual precisamos identificar para AOP , e <paginação> como "00", conforme segue abaixo:

<volume>00</volume>
<issue>00</issue>
<fpage>00</fpage>
<lpage>00</lpage>

Proposta de solução

A ausência dos campos acima configurar um artigo tipo ahead of print.


https://groups.google.com/d/msgid/scielo-xml-sig/c4bd57d0-40ec-4956-98f5-d7e2d0df0882%40googlegroups.com (apenas membros do scielo-xml-sig)

[est. 1 hora] Incoerência em obrigatoriedade de @id em <app> e <supplementary-material>

Dizemos no SPS que @id é obrigatório tanto em <app> quanto em <supplementary-material>, no entanto em casos como o ocorrido na ni v11n4 (arquivo: 1679-6225-ni-11-04-00747.xml), não faz sentido a inserção de @id nas duas tags já que no texto em <body> deverá ser feito uma única xref do tipo app OU supplementary-material.

<app-group> ... <app> <label>Supplementary File 1: Script used for tree searches.</label> <supplementary-material id="suppl01" mimetype="application" mime-subtype="pdf" xlink:href="1679-6225-ni-11-04-00747-s1.pdf"/> </app>

Recomendo retirar o atributo como obrigatório das duas tags, somente mencionar que caso exista xref correspondente deve-se realizar o link das informações obrigatoriamente.

Ver regra : http://docs.scielo.org/projects/scielo-publishing-schema/pt_BR/latest/tagset.html#app-group

Ver regra : http://docs.scielo.org/projects/scielo-publishing-schema/pt_BR/latest/tagset.html#supplementary-material

acréscimo de informação em subj-group

O SPS diz: "...e para ahead-of-print deve ser adotado sempre a seção Articles."

Sugiro acrescentar: Artigos, e Artículos.

Não faz sentido manter uma título de seção (subject) de aop em inglês em um artigo em português ou espanhol.

PS: Sugiro também criar uma seção da tag "subject".

Avaliar a sugestão de identificação de *institution//named-content*

A sugestão foi feita na thread https://groups.google.com/forum/#!topic/scielo-xml/IOgPWN_giXs

<aff id="aff01">
    <label>1</label>
    <institution content-type="orgname">Empresa de Pesquisa Agropecuária de Minas Gerais</institution>
    <addr-line>
        <named-content content-type="city">Lavras</named-content>
        <named-content content-type="state">MG</named-content>
        <named-content content-type="email">[email protected]</named-content>
    </addr-line>
    <country country="BR">Brasil</country>
    <institution content-type="original">Empresa de Pesquisa Agropecuária de Minas Gerais (EP2AMIG), Lavras/MG – Brasil, e-mail: [email protected]</institution>
</aff>

Tickets relacionados:

Inserir elemento */article/response*

Atributos obrigatórios: @id, @response-type e @xml:lang
Os valores de @response-type podem ser addendum, discussion ou reply.

Deve possuir o elemento /article/response/front-stub.

Reavaliar a restrição de tags de formatação nos elementos filhos de *//ref/element-citation*

O elemento <element-citation>[1], apresenta a seguinte restrição:

Nunca manter uma informação toda com formatação <italic>, <bold>, etc, dentro de alguma tag;

I.e., os elementos filhos de //ref/element-citation devem possuir no mínimo 1 caractere em seu text().
Entretanto, uma mensagem na lista scielo-xml[2] sugere um caso de uso onde essa restrição se torna um problema quando partindo do XML Publishing (SciELO PS) deseja-se produzir um PDF (ou outro formato final), mantendo as características originais de formatação.

[1]http://docs.scielo.org/projects/scielo-publishing-schema/pt_BR/1.1-branch/tagset.html#element-citation
[2]https://groups.google.com/forum/#!topic/scielo-xml/naaeqi64KoQ

Inserir documentos do tipo *press release*

  • O valor do atributo /article/@article-type deve ser igual a in-brief
  • No caso de PR de Artigo, deve ser relacionado ao artigo por meio do elemento related-article-type, conforme o exemplo:
...
<article-meta>
    ...
    <permissions>...</permissions>
    <related-article related-article-type="article-reference" id="pr01" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="10.1590/S0104-59702014000200002" ext-link-type="doi"/>
    <counts>...</counts>
</article-meta>
...
  • No caso de PR de Artigo, deve ser inserida uma backref no artigo, conforme o exemplo:
...
<article-meta>
    ...
    <permissions>...</permissions>
    <related-article related-article-type="press-release" id="01" specific-use="processing-only"/>
    <counts>...</counts>
</article-meta>
...

  • No caso de PR de Número, deve ser inserido o elemento article-id com o atributo @pub-id-type="other", conforme o exemplo:
...
<article-meta>
    <article-id pub-id-type="other">00001</article-id>
    ...
</article-meta>
...

Avaliar o uso de *elocation-id* para explicitar a posição do artigo no sumário do número

Atualmente a ordenação no sumário do número depende de regras envolvendo elementos como: fpage, article-id[@pub-id-type="other"] e eventualmente um peso semântico pelo tipo da seção do artigo (e.g. errata deve aparecer no final). Essas regras são implementadas nas aplicações e, portanto, podem variar.

O objetivo desse ticket é de tornar explícita essa ordenação, por meio de um metadado no XML. Algo como:
<elocation-id content-type="summary-order" seq="1"/>


  • Como tratar artigos em ahead of print?
  • Como tratar duplicação de valor entre artigos do mesmo fascículo?
  • É responsabilidade de quem realiza a produção do artigo em XML se preocupar com detalhes da formação do fascículo?
  • Como tratar publicações que seguem o modelo "rolling pass"?

Adicionar definições no glossário

[x] JATS Publishing
[x] ISBN
[x] seções de primeiro nível
[x] w3c
[x] mathml
[ ] NISO JATS table model
[x] ABNT
[x] vancouver
[x] apa
[x] ISO
[x] ISO 639-1


Atualização
[ ] Número

Documentar as regras envolvendo *//sub-article*

  • Definir os valores possíveis em //sub-article/@article-type
  • Regra de formação de //sub-article/@id
  • Pesquisar as recomendações feitas na lista scielo-xml
  • Documentar as regras envolvendo o elemento //sub-article/front-stub

tag <named-content> não abarca todas as necessidades SciELO

Acrescentar na tag named-content a informação em maiúsculo:

Aparece em:
addr-line E INSTITUTION

Acrescentar na tabela o valor "email".

Inserir nota de que named-content do tipo email só pode aparecer na tag de institution do tipo "original" somente.

Erro no conteúdo descritivo do elemento xref

Tem uma coisa estranha no arquivo tagset.rst ele diz:

.. _elemento-xref:

e uma linhas abaixo diz:

Os atributos obrigatórios para @xref são:

@Xref não é um elemento, afinal atributos não podem ter atributos. Isso não é um erro? Não seria em vez de @Xref ?

Tornar obrigatório o preenchimento *//country/@country*

Por motivos de normalização, o valor do atributo deve ser preenchido com o código ISO 3166 (pode ser consultado no serviço http://wayta.scielo.org/).

<aff id="aff1">
    <label>1</label>
    <institution content-type="orgdiv1">Faculdade de Agronomia</institution>
    <institution content-type="orgname">Universidade Federal de Pelotas</institution>
    <addr-line>
        <named-content content-type="city">Pelotas</named-content>
        <named-content content-type="state">RS</named-content>
    </addr-line>
    <email>[email protected]</email>
    <country country="BR">Brasil</country>
    <institution content-type="original">Professor, Faculdade de Agronomia/Universidade Federal de Pelotas. Campus universitário s/n 96010-070 – Pelotas – RS – Brasil [email protected]</institution>
</aff>

Avaliar o uso do atributo *article/@specific-use* para a versão do SPS

Para viabilizar o acesso aos documentos XML arquivados em diferentes versões da especificação SPS, é importante que o documento identifique, explicitamente, sua conformidade com uma determinada versão do SPS.

Exemplo:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//NLM//DTD JATS (Z39.96) Journal Publishing DTD v1.0 20120330//EN" "JATS-journalpublishing1.dtd">
<article xmlns:xlink="http://www.w3.org/1999/xlink" 
             xmlns:mml="http://www.w3.org/1998/Math/MathML" 
             dtd-version="1.0" 
             article-type="research-article" 
             xml:lang="en" 
             specific-use="sps-1.1">
...
</article>

[est. 3 horas] Avaliar *license/license-p* no idioma do artigo ou *en*

O objetivo desse elemento é de informar ao usuário os termos gerais da licença de uso adotada. Essa é a justificativa para a restrição de que o idioma seja conforme o idioma do artigo principal. Entretanto, assumindo que o inglês é o idioma padrão da comunicação científica internacional, seu uso em metadados, como o valor do elemento license-p, não compromete o objetivo da comunicação.

Além do aspecto da comunicação, aceitar o conteúdo em inglês também facilitaria por não demandar a tradução dos termos da licença por parte dos responsáveis pela geração do XML.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.