Índice

• Introdução aos dicionários
• Diretrizes para metadados
• Diretrizes para texto
• HTML básico para dicionários
• Inflexões em dicionários
• Criar um dicionário com o KindleGen
• Testar dicionários Kindle

Introdução aos dicionários

Um dicionário é um eBook Kindle (arquivo MOBI) com tags extras para suporte da função de busca e pesquisa. eBooks de dicionários:

• Contêm um índice primário: uma lista de palavras ou frases que são organizadas em ordem alfabética. Os leitores podem pesquisar essa lista com rapidez ao digitar o início da palavra e selecionar a entrada desejada.
• São marcados como dicionários. Os idiomas de entrada e saída do dicionário devem estar definidos adequadamente para que dispositivos Kindle possam usar o dicionário para busca no livro.

Por exemplo: um dicionário em inglês (monolíngue) lista o inglês como idioma de entrada e de saída. Um dicionário francês-inglês lista francês como o idioma de entrada e inglês como o de saída. Para desenvolver um dicionário bilíngue bidirecional (exemplo: espanhol-francês e francês-espanhol), é necessário criar dois eBooks separados: um para espanhol-francês e outro para francês-espanhol.

Um dicionário Kindle deve conter todos os mesmos componentes de um eBook normal do Kindle. Deve haver um arquivo OPF e arquivos HTML com CSS. Todo dicionário deve conter:

• Uma imagem de capa
• Uma página de direitos autorais
• Quaisquer elementos pré e pós-textuais relevantes (explicações de símbolos, apêndices, etc.)
• Definições de palavras (este é o conteúdo principal do arquivo)

Esse formato atualmente não é compatível com a configuração de fonte.

Diretrizes para metadados

O arquivo OPF de um dicionário é similar aos de outros livros Kindle, com a exceção que contém tags de metadados especializados na seção de <x-metadata>. Estas tags extras do arquivo OPF de um dicionário definem o idioma de entrada e o de saída do dicionário. Caso o dicionário contenha múltiplos índices, o arquivo OPF também especifica o nome do índice de consulta principal.

• O elemento <DictionaryInLanguage> contém o código de idioma ISO 639-1 do idioma para o qual este dicionário foi projetado. Para um dicionário espanhol-francês, o idioma de entrada é o espanhol.
• O elemento <DictionaryOutLanguage> contém o código de idioma ISO 639-1 para o idioma das definições retornadas pelo dicionário. Para um dicionário espanhol-francês, o idioma de saída é o francês.
• O elemento <DefaultLookupIndex> indica o índice que será aberto primeiro quando o dicionário for usado para pesquisa a partir de outro eBook. Esse índice principal deve ser especificado se o dicionário possuir mais de um índice. O nome do índice presente nas tags <DefaultLookupIndex> do arquivo OPF também deve aparecer como o valor do atributo name nos elementos <idx:entry> do conteúdo do dicionário (ver detalhes sobre HTML).

Como exemplo, para um dicionário espanhol-francês, o código de idioma de entrada seria es; o código de idioma de saída seria fr e o índice primário poderia ser nomeado Espanhol. Veja uma lista de códigos do país.

Exemplo: (metadados de dicionário bilíngue)

Para um dicionário monolíngue, o mesmo código de idioma deve aparecer duas vezes: uma para identificar o idioma de entrada e outra para identificar o mesmo idioma como o de saída. Para identificar uma variante regional para os idiomas de entrada e/ou saída, um sufixo regional pode ser anexado ao código ISO 639-1. Por exemplo, en-gb indica Inglês Britânico, enquanto en-us indica Inglês dos EUA.

Exemplo: (metadados de dicionário monolíngue, variante regional)

Diretrizes para texto

Um formato simples e limpo funciona melhor para busca no livro. A Amazon recomenda estes recursos de conteúdo e formatação de dicionários para uma experiência de usuário de alta qualidade:

• O verbete (palavra a ser definida) deve vir em primeiro lugar na entrada, e deve ser diferenciado do conteúdo ao redor (em uma linha só dele, alinhado à esquerda, em negrito).
• Cada entrada de dicionário deve conter uma definição (ou tradução, para dicionários bilíngues).
• Barras horizontais devem aparecer entre cada entrada.
• Cada seção de uma nova letra do alfabeto deve começar em uma nova página.
• Imagens devem ser evitadas (consulte as restrições de imagem).
• Tabelas não devem ser utilizadas (consulte as restrições de tabela).
• Cor da fonte, tamanho e tipo de letra não devem ser forçados (consulte as diretrizes para texto).

HTML básico para dicionários

Formato

Elemento Frameset

Todos os dicionários devem ter um elemento <mbp:frameset> como o primeiro filho do elemento <body>. Esse elemento frameset contém todos os elementos <idx:entry> do dicionário.

O espaço de nomes para este elemento <mbp: frameset> é

xmlns:mbp="https://kindlegen.s3.amazonaws.com/AmazonKindlePublishingGuidelines_PT.pdf" e ele dever ser declarado no elemento de raiz <html> do documento XHTML.

Exemplo:

Índice de verbetes

Para criar um índice alfabético de palavras-chave, é necessário o uso de tags especiais que não são HTML padrão. A fonte ainda será um XHTML válido com essas tags <idx> a mais.

<idx:entry>..</idx:entry>

A tag <idx:entry> marca o escopo de cada entrada a ser indexada. Em um dicionário, cada verbete com sua(s) definição(ões) deve ser colocado entre <idx:entry> e </idx:entry>. Qualquer tipo de código HTML pode ser colocado dentro dessa tag.

A tag <idx:entry> pode ter os atributos name, scriptable e spell. O atributo name indica o índice ao qual o verbete pertence. O valor do atributo name deve ser o mesmo que o nome padrão do índice de pesquisa listado na OPF. O atributo scriptable torna a entrada acessível a partir do índice. O único valor possível para o atributo scriptable é "yes". O atributo spell permite a pesquisa com caractere universal e correção ortográfica durante a pesquisa de palavras. O único valor possível para o atributo spell é "yes".

Exemplo:

A tag <idx:entry> também pode conter um atributo id com o número de identificação sequencial da entrada. Esse número deve corresponder ao valor do atributo id em uma tag de âncora usada para vinculação de referência cruzada:

Exemplo:

O número de identificação da entrada não é usado para busca no livro; em vez disso, a entidade da palavra a ser indexada para pesquisa deve estar contida no elemento<idx:orth>, conforme descrito nas seções a seguir.

<idx:orth>..</idx:orth>

A tag <idx:orth> é usada para delimitar a classificação que aparecerá na lista do índice e que poderá ser pesquisada como verbete de pesquisa. Este é o texto que os usuários podem inserir na caixa de pesquisa para localizar uma entrada.

Exemplo:

Aqui está um exemplo de uma entrada extremamente simples que poderia ser parte de um dicionário de inglês. A partir deste código de exemplo, a palavra "chair" apareceria na lista do índice e seria pesquisável pelos usuários.

Exemplo:

O valor do atributo value pode ser utilizado na tag <idx:orth> para incluir uma classificação escondida na entrada. Esse atributo mantém a funcionalidade de pesquisa na presença da formatação especial que comumente aparece em palavas-chave nos dicionários.

Exemplo:

Se a primeira palavra for exibida no dicionário com um número sobrescrito para indicar homógrafos, com um símbolo de marca registrada, com pontos intermediários para separar sílabas ou com quaisquer outros símbolos adicionados, esta formatação especial deve aparecer no texto entre as tags <idx:orth>, mas não no texto no atributo value. O texto no atributo value deve corresponder exatamente à forma a ser utilizada na pesquisa. Se um atributo value não for fornecido, a entidade entre as tags <idx:orth> será indexada para pesquisa. Se pontos médios, números sobrescritos ou quaisquer outros símbolos forem incluídos no texto entre as tags <idx:orth>, a busca no livro irá falhar, a menos que uma classificação oculta com a forma da palavra de pesquisa seja fornecida no atributo value.

Exemplo:

Se o dicionário usar mais do que um script ortográfico, o atributo format na tag <orth> pode ser usado para identificar cada script da construção do índice.

Exemplo:

Junto com este índice principal de verbetes para todas as entradas no dicionário, a busca no livro também requer um índice suplementar das formas flexionadas de cada palavra-chave. Para construir um índice oculto de inflexões, dados adicionais devem ser aninhados dentro da tag <idx:orth>, conforme abaixo.

Inflexões em dicionários

Os dicionários devem ser desenvolvidos de modo que múltiplas formas flexionadas da raiz de uma palavra levem à mesma entrada. Deve ser fornecida uma lista completa de palavras flexionadas para cada palavra-chave. Se uma entrada utiliza várias ortografias, devem ser fornecidas inflexões separadas para cada ortografia.

Índice de inflexões

Para construir um índice oculto de inflexões, os dados das palavras flexionadas devem estar dentro das tags <idx:infl> e <idx:iform />, que por sua vez devem estar aninhadas no elemento <idx:orth>. Este índice não será diretamente pesquisável pelo usuário, mas em vez disso será utilizado para a busca no livro.

<idx:infl>..</idx:infl>

O elemento <idx:infl> pode conter múltiplos elementos <idx:iform />. Os elementos <idx:iform /> são sempre vazios. Eles são utilizados apenas para carregar atributos e não possuem conteúdo visível. O atributo value indica as formas flexionadas que compõem o índice de inflexão.

Exemplo:

As tags <idx:infl> e <idx:iform />, assim como o atributo value, são obrigatórios. O elemento <idx:infl> também pode conter um atributo inflgrp opcional para designar a categoria gramatica, e o elemento <idx:iform/> pode conter um atruibuto name opcional para indicar a categoria do paradigma de inflexão. Para idiomas que têm muitas inflexões, incluir essas categorias opcionais expandirá o tamanho do índice de inflexões, o que pode resultar em um desempenho mais lento durante a pesquisa de palavras.

Exemplo:

Os valores listados como atributos da tag <idx:iform /> serão invisíveis para o usuário, mas fornecerão as informações necessárias para redirecionar formas flexionadas às palavras-chave associadas durante a pesquisa dentro do livro. Para informar o usuário sobre as categorias da inflexão, um texto adicional deve ser incluído no corpo da entrada (ou seja, ao lado da definição e exemplos).

<idx:key>..</idx:key> (OBSOLETO)

Como a tag <idx:infl>, a tag <idx:key> é projetada para permitir a busca por uma entrada no índice por meio da pesquisa de uma palavra alternativa. No entanto, a presença de tags <idx:key> em um dicionário Kindle pode criar instabilidade na funcionalidade de pesquisa e interferir no funcionamento do parâmetro de correspondência exata. Por essas razões, o uso de tags <idx:key> nos dicionários Kindle está obsoleto. Em vez disso, as tags <idx:infl> e <idx:iform /> devem ser usadas para as palavras alternativas de busca.

Parâmetro de correspondência exata

Por padrão, o dispositivo Kindle usa um algoritmo difuso para fazer correspondências entre diacríticos ao pesquisar palavras. Idiomas que usam diacríticos contrastantes para distinguir entre formas de palavras distintas devem usar o atributo exact="yes" na tag <idx:iform /> para forçar a correspondência exata de diacríticos durante a pesquisa.

Exemplo:

Criar um dicionário com o KindleGen

Ao desenvolver um dicionário com o KindleGen através da linha de comando, use a seguinte sintaxe:

Se as entradas do dicionário estiverem contidas em um único e grande arquivo XHTML, então o KindleGen pode não ser capaz de construir o dicionário. Se o dicionário não puder ser construído, o problema pode ser resolvido dividindo o conteúdo do dicionário em dois ou mais arquivos de XHTML.

Consulte a orientação sobre como usar o KindleGen.

Testar dicionários Kindle

Teste do formato

A Amazon recomenda verificar se o dicionário convertido está devidamente formatado para proporcionar uma boa experiência visual para o usuário:

• Verifique a formatação das definições folheando o dicionário e lendo várias definições. (O formato do dicionário pode ser verificado usando o Kindle Previewer ou qualquer dispositivo Kindle; no entanto, os testes de pesquisa requerem o uso de um E-reader.)
• Verifique várias palavras para descobrir se há caracteres incompatíveis, palavras quebradas ou unidas, boa exibição de caracteres acentuados, símbolos, guia de pronúncia, etc.
• Verifique se não há erros de digitação.
• Verifique se links (caso houver) estão funcionando corretamente. (Os links serão desativados na janela de busca no livro, mas eles devem funcionar dentro do próprio dicionário.)
• Se imagens forem utilizadas, verifique se elas estão claras e legíveis.
• Verifique se a cor e o tipo de fonte não estão forçados.

Teste da pesquisa

A Amazon recomenda verificar se as definições são exibidas corretamente quando o dicionário é usado para procurar palavras em outros livros. Este componente do teste pode ser feito apenas com E-readers (não incluindo o Kindle Previewer), pois somente os E-readers permitem que o usuário defina o dicionário padrão para pesquisa.

• Carregue o dicionário no E-reader. Para fazer isso, conecte o Kindle ao seu computador com um cabo USB-to-mini-USB. O computador vai detectar o dispositivo. Na janela que aparece, você deve ver uma pasta chamada Documentos. Coloque o arquivo do dicionário nessa pasta e, em seguida, ejete o Kindle do computador.
• Configure o dicionário-teste como o dicionário padrão para pesquisa:
  • Kindle Paperwhite : Vá até Início > Menu > Configurações > Opções do dispositivo > Idioma e Dicionários > Dicionários > [Idioma Fonte]
• Procure por diversas palavras para descobrir qual definição é exibida. Abra um livro que não seja o dicionário, selecione uma palavra e observe a definição que aparece na janela de pesquisa. Se a pesquisa falhar inteiramente, verifique se há erros nas tags do HTML. Sugestões de palavras para pesquisa incluem:
  • Conjugações de verbos regulares e irregulares
    • Exemplo: caminha, caminhar, caminhou, caminhando; ir, vai, foi, tinha ido, irá
  • Substantivos, adjetivos, advérbios e suas conjugações/declinações
    • Exemplo: mesa, mesas; lobo, lobos; quente, mais quente, quentíssimo
  • Convenções gramaticais e de pontuação comumente usados no idioma
    • Exemplo: contrações, elisões, verbos com pronomes clíticos
• Verifique a exibição do índice do dicionário. Para fazer isso, abra o dicionário e comece a digitar uma palavra na caixa de pesquisa. Uma lista em ordem alfabética de palavras-chave deve aparecer e deve se atualizar dinamicamente com base nas letras digitadas. Ao selecionar uma palavra-chave da lista do índice, o usuário deverá ser redirecionado ao verbete de dicionário desta palavra-chave.