Guia de gestão do site

Introdução

Objetivos deste guia:

  • padronizar as práticas editoriais da tradução para o português do Formato MARC 21 para Dados de Autoridade;
  • auxiliar na manutenção e atualização deste site.

Organização

Páginas: As páginas são utilizadas para o conteúdo introdutório, informações gerais, grupos de campos, campos e apêndices, conforme a versão original. Além dessas, a foram criadas as seguintes páginas para a tradução para o português:

Posts: Os posts são utilizados para a divulgação de notícias como as atualizações do Formato e/ou da tradução. Atualmente, os posts não estão sendo utilizados.

Categorias: As categorias são atribuídas às páginas, indicando grupos de páginas introdutórias, de campos e de apêndices. Se os posts forem utilizados, é necessário criar categorias específicas para eles, tais como “Notícias” ou “Atualizações”.

Usuários: membros do GT-CAT e suporte técnico da FEBAB responsáveis pela gestão do site (WordPress e plugins) e da tradução.


Orientações gerais

O conteúdo das páginas está organizado em blocos. Cada título, parágrafo, lista, exemplo, linha horizontal (separador), sumário e botão é um bloco.

Ao colar textos copiados de outros sites/arquivos, sempre utilize a opção Ctrl + Shift + V, para colar o texto sem a formatação de origem.

A tipografia (fonte) e o tamanho da fonte nunca devem ser alterados. A cor da fonte pode ser alterada apenas para sinalizar as modificações decorrentes da última atualização do formato.

A seguir, são apresentadas regras gerais para a formatação das páginas. Exceções a essas regras são permitidas apenas em páginas especiais (introdutórias, apêndices).

Para os títulos das seções, utilize os blocos de Títulos. Não utilize CAIXA ALTA e negrito nos títulos de seções, pois o WordPress já possui a formatação necessária para destacar os títulos. Os títulos das seções devem estar alinhados à esquerda. Altere o nível do título conforme a seção do texto:

  • H2 para seções primárias (Definição e escopo do campo, Orientações para aplicação do campo, etc.)
  • H3 para seções secundárias (Indicadores, Subcampos, Histórico, Exemplos, Convenções de entrada, etc.)
  • H4 para seções terciárias (Primeiro indicador, Segundo indicador, subcampos)

Em geral, cada parágrafo do texto deve estar separado em um bloco de parágrafo, não importando a quantidade de linhas. Os parágrafos devem estar sempre com o alinhamento à esquerda. Em casos excepcionais, se for necessário incluir quebras de linha dentro de um bloco de parágrafo (ex.: no sumário manual), utilize atalho Ctrl + Shift.

Os destaques tipográficos (itálico, negrito) que constam na versão original não necessariamente são mantidos na tradução:

  • nos parágrafos, o itálico deve ser utilizado apenas para palavras em idioma estrangeiro, incluindo nomes próprios de instituições e de documentos;
  • nos exemplos, o itálico deve ser utilizado apenas para os comentários entre colchetes;
  • nos exemplos, o negrito deve ser utilizado para as etiquetas, indicadores e códigos de subcampos, conforme o original;
  • os destaques/ênfases que constam no original em itálico podem ser formatados em negrito;
  • as aspas podem ser mantidas quando utilizadas com o intuito de citar trechos.

Os separadores (linhas horizontais) tem o objetivo de separar as seções, facilitando a leitura. Nas páginas padrão, os separadores estão em lugares predefinidos. Nas demais páginas, deve ser utilizado sempre que necessário.

Os blocos pré-formatados possuem formatação diferenciada (fonte monoespaçada e plano de fundo cinza) e são usados nos exemplos e nas convenções de entrada. Diferentemente dos blocos de parágrafo, um bloco preformatado pode conter mais de um parágrafo.

É possível alterar o tipo de alguns blocos, por exemplo, é possível transformar uma parágrafo em um título ou em uma lista ou em um bloco pré-formatado. Para isso:

  • clique sobre o bloco que deseja transformar;
  • clique no primeiro ícone da barra que aparecerá acima do bloco;
  • em Transformar em, escolha o tipo desejado.

Texto introdutório

Para o texto introdutório de cada página, por exemplo, a Definição e escopo do campo, inclua cada parágrafo em um bloco.

Botões:

  • preencha o botão com o mês e o ano da última atualização da versão original da página, conforme consta canto superior direito;
  • no botão , inclua o link para a página original e marque a opção Abrir em uma nova aba.

Detalhes técnicos: os ícones da fonte Awesome que acompanham os botões são incluídos via CSS. O botão com a data da última atualização tem a classe marc-button-update, e o botão do link tem a classe marc-button-original; ambos possuem largura de 50%.


Sumários

Sumários automáticos

Determinadas páginas possuem um sumário automático, gerado a partir dos títulos das seções (H2, H3, H4). Ou seja, para que o sumário seja atualizado, basta atualizar o título da seção e salvar a página. Os links do sumário e para as seções serão criados automaticamente.

As páginas com sumário automático possuem um bloco shortcode com o código

. Esse código e este bloco não devem ser alterados.

Detalhes técnicos: O sumário automático é gerado pelo plugin Easy Table of Contents.

Sumários manuais

Determinadas páginas (por exemplo, páginas de grupos de campos e de informações gerais) possuem sumários feitos manualmente. Nestas páginas, sempre que houver alteração nos títulos das seções/páginas é necessário:

  • atualizar o título no sumário;
  • conferir/incluir a âncora no título da seção;
  • conferir/incluir o link no sumário.

Detalhes técnicas: Os sumários manuais estão em blocos de parágrafo com o classe marc-field-group-list.


Indicadores

Para o título da seção Indicadores, use o nível H3. Para os títulos Primeiro indicador – … e Segundo indicador – …, use o nível H4.

Os valores e significados dos indicadores devem estar em negrito, sendo que:

  • se o indicador possuir apenas uma lista de valores, sem explicações e exemplos entre eles, inclua todos dentro de um único bloco de parágrafo; utilize Shift + Enter para fazer as quebras de linha dentro do parágrafo;
  • se forem dadas explicações e exemplos dos indicadores, distribua o conteúdo entre blocos de parágrafo.

Inclua um separador (linha horizontal) entre o primeiro e o segundo indicador.

Para um indicador indefinido, use a frase padrão “Indefinido e contém um espaço em branco (#).” Se os dois indicadores forem indefinidos, repita esta frase.

Os exemplos de uso dos indicadores devem seguir a formatação padrão para Exemplos.

Os valores dos indicadores não são incluídos nos Sumários.


Subcampos

Para o título da seção Subcampos, use o nível H3. Para cada subcampo, use o nível H4.

No título H4 de cada subcampo deve ser incluída uma âncora com o código do subcampo:

  • clique no título do subcampo;
  • clique em Avançado, na lateral direita;
  • preencha a Âncora de HTML apenas com a letra (minúscula) ou número do subcampo; não inclua o $ na âncora.

Inclua um separador (linha horizontal) ao término da explicação dos exemplos de cada subcampo.


Exemplos

Para os exemplos, utilize o blocos pré-formatados:

  • se na versão original os exemplos estiverem separados entre si por uma linha em branco, inclua-os em diferentes blocos;
  • Se na versão original os exemplos não estiverem separados por uma linha em branco, inclua-os em um mesmo bloco.

Negrito:

  • use negrito nas etiquetas dos campos, nos indicadores e nos códigos de subcampo em destaque, conforme versão original;
  • se na versão original não houver destaque em nenhum campo (por exemplo, como ocorre com os campos X00, X10, etc.), use o negrito nos campos explicados na página.

Comentários:

  • os comentários dos exemplos são traduzidos;
  • mantenha os comentários entre colchetes e em itálico.

Links

Para incluir um link, selecione o texto desejado e tecle Ctrl + K. O WordPress abrirá uma janela para que você informe o destino link. Preencha essa janela conforme o tipo de link. Após a inclusão do destino, tecle Enter.

Links internos (apontam para outras páginas do próprio site):

  • na janela que foi aberta, digite o nome da página para a qual será criado o link;
  • não marque a opção Abrir em uma nova aba;
  • links internos devem ser incluídos sempre que constaram na versão original e/ou que um campo for mencionado em um parágrafo de texto de uma página que não seja a página do próprio campo.

Links para âncoras (apontam para partes/seções da própria página):

  • estes links geralmente são utilizados para subcampos mencionados no decorrer de uma página (fora da seção que explica o próprio subcampo);
  • na janela que foi aberta, digite # seguido na letra minúscula ou número do subcampo de destino;
  • para que a âncora funcione, é necessário que a opção Âncora de HTML esteja devidamente preenchida na seção para a qual o link aponta;
  • links para as âncoras #historico são utilizados nos botões com o mês e ano da última atualização.

Links externos (apontam para outros sites):

  • devem ser incluídos sempre que constarem na versão original;
  • ao incluir o link, use o https;
  • marque a opção Abrir em uma nova aba.

Convenções de entrada


Históricos

Todas as páginas devem ter a seção Histórico, com o Título nível H3 e Âncora de HTML #historico. A primeira lista deve trazer o histórico traduzido da versão original. Após, deve constar um parágrafo apenas com “Histórico da tradução:” seguido de uma lista com as datas no formato AAAA-MM-DD das alterações realizadas na tradução. Sendo que:

  • não use negrito e nem itálico;
  • use caixa alta conforme o original: NOVO, ALTERADO, OBSOLETO, REESCRITO, etc.;
  • não inclua links nos campos/subcampos mencionados no histórico;
  • use subníveis sempre que necessário.

Atualizações do Formato