Merge pull request #2868 from scieloorg/t2813

t2813

docs/source/index_pt.rst

@@ -14,21 +14,21 @@ Para a **Produção de XML**:
 
 - **XML Package Maker**
 
-  - valida pacotes de XML SPS produzidos por quaisquer ferramentas. 
-  - **uso obrigatório** para a produção de pacotes XML validados de acordo com SPS.
+  - valida pacotes de XML SciELO PS produzidos por quaisquer ferramentas; 
+  - **uso obrigatório** para a produção de pacotes XML validados de acordo com SciELO PS.
 
 - **Markup**
 
-  - macro para Word para identificar os elementos estruturais e semânticos dentro de um texto.
-  - gerar o XML SPS a partir da identificação destes elementos.
-  - **uso opcional** já que é permitido e incentivado a usar quaisquer ferramentas para produzir os XML de acordo com o SPS.
+  - macro para Word para identificar os elementos estruturais e semânticos dentro de um texto;
+  - adaptado para gerar o XML segundo SciELO PS a partir da identificação destes elementos;
+  - **uso opcional** já que é permitido e incentivado a usar quaisquer ferramentas para produzir os XML de acordo com o SciELO PS.
 
 
 Para **Gestão de Coleções** (para uso **somente** das Coordenações de uma Coleção SciELO):
 
-- Title Manager
-- Converter
-- XML Converter
+- Title Manager;
+- Converter;
+- XML Converter;
 - XML SciELO (Exportador de XML para outras bases: ISI e PubMed)
 
 -------------

docs/source/pt_how_to_generate_xml-prepara.rst

@@ -47,7 +47,7 @@ Não deve existir o arquivo */scielo/bin/markup/markup_journals_list.csv*. Se ex
 
 No lugar, deve existir:
 
-- *??_issue.mds*: atualizado/criado assim que qualquer dado de fascículo é criado ou atualizado
+- *??_issue.mds*: atualizado/criado assim que qualquer dado de número é criado ou atualizado
 - *journal-standard.txt*: atualizado/criado assim que qualquer dado de periódico é criado ou atualizado
 
 Estes arquivos são gerados pelo programa `Title Manager <titlemanager.html>`_ ou `SciELO Manager <http://docs.scielo.org/projects/scielo-manager/en/latest/>`_.
@@ -75,7 +75,7 @@ esteja como segue:
 
 Veja que dentro da pasta *markup_xml* foram inseridas duas pastas, no mesmo nível:
 
- * *src*: utilizada para inserir os arquivos *PDF*, mídia e suplementos.
+ * *src*: utilizada para inserir os arquivos *PDF*, mídia, ativos digitais (imagens, tabelas etc) e suplementos.
  * *scielo_markup*: utilizada para inserir os arquivos *.doc* ou *.docx*.
 
 
@@ -94,7 +94,7 @@ Veja que dentro da pasta *markup_xml* foram inseridas duas pastas, no mesmo nív
 Pasta *src*
 .........
 
-Os arquivos referenciados no arquivo marcado, ou seja, aqueles que identificados em **href**, devem estar na pasta *src* e devem ser nomeados da mesma forma no *.doc* (ou *.docx*). Nessa pasta também devem ser inseridos todos os arquivos que farão parte do pacote final, nas extensões desejadas. 
+Os arquivos referenciados no arquivo marcado, ou seja, aqueles identificados em **href**, devem estar na pasta *src* e devem ser nomeados da mesma forma no *.doc* (ou *.docx*). Nessa pasta também devem ser inseridos todos os arquivos que farão parte do pacote final, nas extensões desejadas. 
 
 Exemplo: 
 
@@ -111,17 +111,28 @@ Figura
   * Mesmo nome do arquivo *.doc* (sem a extensão) + *f* + identificação da figura + extensão do arquivo de imagem; ou
   * Mesmo nome do arquivo *.doc* (sem a extensão) + *fig* + identificação da figura + extensão do arquivo de imagem.
 
-Exemplo: *a01f01.svg*, *a01f01.tiff*, *a01f01.jpg*, *a01f01.png*, *a01f01.gif*, ...
+Exemplo: *a01f01.svg*, *a01f01.tiff*, *a01f01.jpg*, *a01f01.png*, ...
 
 
 Tabela
 ------
 
   * Mesmo nome do arquivo *.doc* (sem a extensão) + *t* + identificação da tabela + extensão do arquivo de imagem; ou
   * Mesmo nome do arquivo *.doc* (sem a extensão) + *tab* + identificação da tabela + extensão do arquivo de imagem.
+  * Mesmo nome do arquivo *.doc* (sem a extensão) + *t*
 
-Exemplo: *a01t01.svg*, *a01t01.tiff*, *a01t01.jpg*, *a01t01.png*, *a01t01.gif*, ...
+Exemplo: *a01t01.svg*, *a01t01.tiff*, *a01t01.jpg*, *a01t01.png*, ...
+
+
+Tabela codificadas em XHTML
+---------------------------
 
+ * Mesmo nome do arquivo *.doc* (sem a extensão) + *t* + identificação da tabela + extensão do arquivo html;
+ * Mesmo nome do arquivo *.doc* (sem a extensão) + *tab* + identificação da tabela + extensão do arquivo html;
+
+Exemplo: *a01t01.html*, *a01tab01.html*, ...
+
+..  note:: No caso de SciELO Brasil, a codificação da tabela é obrigatória. 
 
 Equation
 --------
@@ -132,6 +143,7 @@ Equation
 
 Exemplo: *a01eq1.svg*, *a01eq1.tiff*, *a01eq1.jpg*, *a01eq1.png*, *a01eq1.gif*, ...
 
+..  note:: No caso de SciELO Brasil, a codificação de equações é obrigatória.
 
 No arquivo marcado, o Markup rotula automaticamente os objetos gráficos, identificando-os da seguinte forma **[graphic href="?a01"] {elemento gráfico fica aqui} [/graphic]**. Este valor não deve ser alterado, pois desta forma, o Markup é capaz de associar esta referência com os arquivos localizados na pasta *src*.
 
@@ -141,16 +153,15 @@ No arquivo marcado, o Markup rotula automaticamente os objetos gráficos, identi
 .. image:: img/src_img_report_01.png
 
 
-
 O Markup também renomeia as imagens para o padrão já estabelecido. 
 
 
 .. image:: img/src_img_report_02.png
 
 
-No entanto, quando os arquivos correspondentes na pasta *src* não existem, o Markup exporta a imagem inserida no próprio arquivo *.doc*, mas há perda da qualidade da imagem. Recomenda-se, então, que as imagens de boa qualidade estejam na pasta src antes da geração do *XML*.
+No entanto, quando os arquivos correspondentes na pasta *src* não existem, o Markup exporta a imagem inserida no próprio arquivo *.doc*, mas há perda da qualidade da imagem. Recomenda-se, então, que as imagens de boa qualidade estejam na pasta *src* antes da geração do *XML*.
 
-O relatório indica de onde as imagens foram obtidas, se da pasta src ou extraídas do documento.
+O relatório indica de onde as imagens foram obtidas, se da pasta *src* ou extraídas do arquivo marcado *.doc*.
 
 
 .. image:: img/src_img_report_03.png
@@ -172,7 +183,7 @@ Para otimizar o processo de marcação dos elementos básicos do arquivo, é nec
 
 **Instruções para formatação de dados básicos do artigo:**
 
- * Linha 1: inserir número de *DOI*, caso não exista deixar linha em branco;
+ * Linha 1: inserir número de *DOI*, caso não exista começar pela seção do sumário;
  * Linha 2: inserir a seção do sumário, caso não exista deixar linha em branco;
  * Linha 3: título do artigo;
  * Linhas seguintes: Títulos traduzidos do arquivo;
@@ -181,31 +192,77 @@ Para otimizar o processo de marcação dos elementos básicos do arquivo, é nec
  * Pular 1 linha para separar autores de afiliações;
  * Cada afiliação deve estar em uma linha separada e ter o *label* de sua afiliação sbrescrito para que o programa consiga fazer a identificação automática;
  * Pular 1 linha para separar afiliação de resumos;
- * Resumos estruturados devem estar com os nomes das seções em negrito;
- * Palavras-chave: os separadores devem ser ou vírgula ou ponto e vírgula;
- * Seções: negrito, 16 pt, centralizadas;
- * Subseções: negrito, 14 pt, centralizadas;
- * Subseção de subseção: negrito, 13 pt, centralizadas;
+ * O título do *resumo* deve estar em negrito em um parágrafo. O resumo deve começar no parágrafo seguinte;
+ * No caso de *resumos estruturados*, título da seção em negrito e cada seção em um parágrafo;
+ * O título do grupo de *palavras-chave:* deve estar em negrito. As palavras-chave devem ser separadas por vírgula ou ponto e vírgula;
+ * Seções: negrito, 16 pt;
+ * Subseções: negrito, 14 pt;
+ * Subseção de subseção: negrito, 13 pt;
  * Texto: formatação livre;
- * Para tabelas, *label* e legenda devem estar na linha antes da imagem; os demais, após a imagem;
+ * Para tabelas, *label* e legenda devem estar na linha antes do corpo da tabela; e as notas de tabela após o corpo da tabela;
  * Separador de *label* e legenda: dois-pontos e espaço ou espaço + hífen + espaço ou ponto + espaço;
  * Para tabelas codificadas, o cabeçalho deve estar em negrito;
- * A citação de autor/data no corpo do texto deve ser: sobrenome do autor, ano;
+ * A citação do tipo autor/data no corpo do texto deve ser: sobrenome do autor, ano;
  * Para citação no sistema numérico no corpo do texto: número entre parênteses e sobrescrito;
  * Notas de rodapé no corpo do texto: se identificadas com número devem estar em sobrescrito, mas não entre parênteses;
  * Citação direta longa (*quote*): recuo de 4 cm da margem esquerda.
 
 
 Exemplo:
 
-.. image:: img/doc-mkp-2mostra.jpg
+Dados iniciais:
+.. image:: img/doi.png
    :height: 400px
    :width: 200px
    :align: center
 
+Autores e afiliação:
+.. image:: img/autores.png
+   :height: 400px
+   :width: 200px
+   :align: center
 
-.. raw:: html
+Resumo simples + palavras-chave:
+.. image:: img/resumo-simples.png
+   :height: 400px
+   :width: 200px
+   :align: center
 
-   <iframe width="854" height="480" src="https://www.youtube.com/embed/kaYRu-bkhBE?list=PLQZT93bz3H79NTc-aUFMU_UZgo4Vl2iUH" frameborder="0" allowfullscreen></iframe>
+Resumo estruturado + palavras-chave:
+.. image:: img/resumo-estruturado.png
+   :height: 400px
+   :width: 200px
+   :align: center
+
+Figuras:
+.. image:: img/ex-img.png
+   :height: 400px
+   :width: 200px
+   :align: center
+
+Tabelas:
+.. image:: img/tabelas.png
+   :height: 400px
+   :width: 200px
+   :align: center
+
+Citação do tipo autor/data:
+.. image:: img/cit-data.png
+   :height: 400px
+   :width: 200px
+   :align: center
+
+Citação numérica:
+.. image:: img/cit-num.png
+   :height: 400px
+   :width: 200px
+   :align: center
+
+Citação direta longa:
+.. image:: img/cit-direta.png
+   :height: 400px
+   :width: 200px
+   :align: center
 
 .. {"reviewed\_on": "20170320", "by": "carolina.tanigushi@scielo.org"}
+.. {"reviewed\_on": "20171206", "by": "javani.araujo@scielo.org"}

docs/source/pt_installation_configure.rst

@@ -68,8 +68,8 @@ Markup
 
 5. Selecionar:
 
-   - **Markup**: program to identify the bibliographic elements in the articles/texts
-   - **Markup - Automata files** (opcionalmente): examples of files for automatic markup
+   - **Markup**: programa para identificar elementos de um artigo/texto
+   - **Markup - Automata files** (opcionalmente): examplos de arquivos para marcação automática de referências bibliográficas
 
 
     .. image:: img/howtoinstall_programs.png
@@ -128,9 +128,9 @@ SciELO PC Programs Completo: Title Manager, Converter, Markup, XPM etc
 
 5. Selecionar os programas:
 
-  - Title Manager: program to manage journals and issues databases
-  - Converter: program to load the marked documents into the database
-  - XML SciELO: (opcional) program to create XML format for PubMed
+  - Title Manager: programa para gestão da coleção de periódicos
+  - Converter: programa de conversão de documentos marcados para a base de dados
+  - XML SciELO: (opcional) programa para criar formato XML para a base de dados PubMed
 
 
     .. image:: img/howtoinstall_programs.png
@@ -171,8 +171,8 @@ SciELO PC Programs Completo: Title Manager, Converter, Markup, XPM etc
 Como configurar
 ===============
 
-XML Package Maker and XML Markup
-================================
+XML Package Maker e XML Markup
+==============================
 
 Por padrão o programa funciona considerando acesso à Internet disponível, ausência de proxy para acesso à internet e uso do packtools como validador de estrutura de XML (em substituição ao style-checker).
 
@@ -197,12 +197,10 @@ Exemplo dos parâmetros preenchidos:
 Title Manager e Converter
 =========================
 
-Configurar a variável de ambiente:
+Configurar a variável de ambiente: Painel de controle -> Segurança e Manutenção -> Sistema -> Configurações avançadas do Sistema -> Variáveis de ambiente.
 
-  Set OS23470a to the environment variable BAP, by accessing the Windows menu: Control Panel -> Performance and Maintenance -> System -> Advanced Settings -> Environment variables.
-
-  Check if the variable already exists. 
-  If it does not, click New and enter the value.
+  Verifique se a variável já existe. 
+  Em caso negativo, clique em Novo e adicione o valor.
 
     .. image:: img/installation_setup_bap.jpg
 
@@ -229,7 +227,7 @@ Trocar **c:\\home\\scielo\\www** pela localização do site local. Por exemplo:
 Validação de tabelas e fórmulas
 -------------------------------
 
-O padrão de exigência para tabelas e fórmulas é que elas sejam codificadas.
+Para SciELO Brasil, o padrão de exigência para tabelas e fórmulas é que elas sejam codificadas.
 
 Para alterar este nível, editar o arquivo que correspond a **c:\\scielo\\bin\\scielo_collection.ini**:
 
@@ -245,13 +243,13 @@ Para alterar este nível, editar o arquivo que correspond a **c:\\scielo\\bin\\s
 Menu de aplicação
 =================
 
-Sometimes the menu of the application will be created only for the Administrator user. 
+Em alguns casos, o menú da aplicação será criado apenas com o usuário de administrador. 
 
 .. code::
 
   C:\\Documents and Settings\\Administrador\\Menu Iniciar\\Programas
 
-In this case, copy the SciELO folder to All Users folder, to all users have the menu.
+Neste caso, copie a pasta SciELO para a pasta Usuários para que todos os usuários tenham o menú disponível. 
 
 .. code::
 

docs/source/pt_installation_requirements.rst

@@ -3,9 +3,9 @@
 Pré-requisitos
 ==============
 
-Os pré-requisitos são procedimentos que devem ser executados antes da instalação de SciELO PC Programs.
+Os pré-requisitos são procedimentos/programas que devem ser executados antes da instalação de SciELO PC Programs.
 
-Uma vez cumpridos os requisitos, não é necessário executá-los novamente ou todas as vezes que o SciELO PC Programs for instalado / atualizado.
+Uma vez cumpridos os requisitos, não é necessário executá-los todas as vezes que o SciELO PC Programs for instalado / atualizado.
 
 Verificar os pré-requisitos
 ===========================
@@ -39,7 +39,7 @@ Verificar a instalação de Python + pip
 
   .. note::
 
-     ao executar este comando a versão do Python não necessariamente tem que ser igual a da imagem
+     ao executar o comando para verificar a versão do Python não necessariamente ela será igual a da imagem
 
 
 4. Caso o resultado não seja o esperado, repetir todas as instruções anteriores.
@@ -56,7 +56,7 @@ Verificar a instalação de Python + pip
 
   .. note::
 
-     ao executar este comando a versão de pip não necessariamente tem que ser igual a da imagem
+     ao executar o comando para verificar a versão de pip não necessariamente ela será igual a da imagem
 
 
 7. Caso o resultado não seja o esperado, **reinstalar Python**.
@@ -181,42 +181,42 @@ Depois de instalar Java, abrir a "Configuração do Sistema", indicar a localiza
 
 .. _add-paths:
 
-Add aplicação no PATH
-,,,,,,,,,,,,,,,,,,,,,
+Adicionar aplicação no PATH
+,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
-Use a shortcut to open that window is: Windows + Pause Break key.
+O atalho para abrir a janela é: Windows + Pause Break key.
 
 .. image:: img/howtoinstall_path_atalho.jpg
 
-Or click on **Computer** with right button of the mouse.
+Ou clique em **Computador** com o botão direito do mouse.
 
 .. image:: img/howtoinstall_path_computer.png
 
-Then click on **Properties**.
+Então clique em **Propriedades**.
 
 .. image:: img/howtoinstall_path_computer_properties.png
 
 
 
-**Computer System Configuration**
+**Configuração do Sistema**
 
 
 .. image:: img/howtoinstall_path_variavel.jpg
 
 
-Click on Advanced Settings.
+Clique em configurações avançadas do sistema
 
 .. image:: img/howtoinstall_path_conf-advanc.jpg
 
-Then click on Environment Variables. 
+E depois em Variáveis de Ambiente 
 
 .. image:: img/howtoinstall_path_open-variavel.jpg
 
-Find Path variable in the list.
+Encontre o caminho da lista de variáveis
 
 .. image:: img/howtoinstall_path_search-path.jpg
 
-Select Path, then click on **Edit** button.
+Selecione o Path e clique em **Editar**
 
 .. image:: img/howtoinstall_path_select_variable.png