Inhoudsopgave

• Inleiding tot woordenboeken
• Richtlijnen voor metagegevens
• Richtlijnen voor tekst
• Basis-HTML voor woordenboeken
• Verbuigingen voor woordenboeken
• Een woordenboek opbouwen met KindleGen
• Kindle-woordenboeken testen

Inleiding tot woordenboeken

Een woordenboek is een Kindle-e-book (MOBI-bestand) met extra tags die zijn toegevoegd om (op)zoekfunctionaliteit te ondersteunen. Woordenboeken als e-books:

• Bevatten een primaire index: een lijst met woorden of zinnen die alfabetisch zijn gesorteerd. Lezers kunnen deze lijst snel doorzoeken door het begin van het gezochte woord te typen en de gewenste term te selecteren.
• Zijn gemarkeerd als woordenboeken. De bron- en doeltaal van het woordenboek moeten correct zijn gedefinieerd, zodat Kindle-apparaten het woordenboek kunnen gebruiken voor zoekopdrachten in het boek.

Een Engels (ééntalig) woordenboek vermeldt bijvoorbeeld Engels als brontaal én als doeltaal. Een Frans-Engels woordenboek vermeldt Frans als brontaal en Engels als doeltaal. Als je een bidirectioneel tweetalig woordenboek (bijvoorbeeld: Spaans-Frans en Frans-Spaans) wilt maken, moet je twee aparte e-books maken: één voor Spaans-Frans en één voor Frans-Spaans.

Een Kindle-woordenboek moet dezelfde componenten bevatten als een normaal Kindle-boek. Er moet een OPF-bestand zijn en er moeten HTML-bestanden met CSS-codes zijn. Elk woordenboek moet onder meer bestaan uit:

• Een omslagafbeelding
• Een copyrightpagina
• Relevant materiaal vooraan of achteraan (uitleg van symbolen, bijlagen, etc.)
• Definities van woorden (dit vormt het grootste gedeelte van het bestand)

Verbeterde typografie wordt momenteel niet ondersteund door deze indeling.

Richtlijnen voor metagegevens

Het OPF-bestand van een woordenboek lijkt op het OPF-bestand van andere Kindle-boeken, maar verschilt daarvan doordat het in de sectie <x-metadata> speciale metagegevenstags bevat. Met deze extra tags in het OPF-bestand worden de brontaal en de doeltaal van het woordenboek ingesteld. Als het woordenboek meerdere indexen bevat, wordt in het OPF-bestand ook de naam van de primaire zoekindex gedefinieerd.

• Het element <DictionaryInLanguage> bevat de ISO 639-1-taalcode voor de taal van de boeken waarbij dit woordenboek moet worden gebruikt. Bij een Spaans-Frans woordenboek is de brontaal Spaans.
• Het element <DictionaryOutLanguage> bevat de ISO 639-1-taalcode voor de taal van de definities die het woordenboek als zoekresultaat toont. Bij een Spaans-Frans woordenboek is de doeltaal Frans.
• Het element <DefaultLookupIndex> geeft de index aan die als eerste wordt geopend wanneer het woordenboek vanuit een ander e-book voor opzoeken wordt gebruikt. Als het woordenboek meer dan één index bevat, moet de standaardindex worden opgegeven. De indexnaam die tussen de <DefaultLookupIndex>-tags in het OPF-bestand staat, moet ook vermeld zijn als waarde van het kenmerk name in de <idx:entry>-elementen in de inhoud van het woordenboek (zie details over HTML).

Voor een Spaans-Frans woordenboek zou de brontaalcode bijvoorbeeld es zijn; de doeltaalcode zou fr zijn en de primaire index kan Spanish als naam hebben. Bekijk een lijst met landcodes.

Voorbeeld: (metagegevens voor een tweetalig woordenboek)

Voor een ééntalig woordenboek moet twee keer dezelfde taalcode worden gebruikt: eenmaal om de brontaal aan te geven en nogmaals om dezelfde taal als doeltaal aan te geven. Als je een regionale variant van de bron- en/of de doeltaal wilt aangeven, kun je een regionaal suffix aan de ISO 639-1-code toevoegen. Bijvoorbeeld: en-gb geeft Brits-Engels aan, terwijl en-us Amerikaans-Engels aangeeft.

Voorbeeld: (metagegevens voor een ééntalig woordenboek in een regionale variant)

Richtlijnen voor tekst

Een eenvoudige, duidelijke indeling werkt het beste voor opzoekacties in het boek. Voor het meeste gebruiksgemak raadt Amazon de volgende woordenboekinhoud en opmaakkenmerken aan:

• Het trefwoord (het woord dat wordt gedefinieerd) moet als eerste vermeld worden en moet van de omringende content worden onderscheiden (op een eigen regel, links uitgelijnd, in een vet lettertype).
• Elke woordenboekterm moet een definitie bevatten (of een vertaling, bij tweetalige woordenboeken)
• Tussen twee termen moet telkens een horizontale lijn komen.
• Elke sectie voor een volgende letter van het alfabet moet op een nieuwe pagina beginnen.
• Afbeeldingen moeten worden vermeden (zie beperkingen bij afbeeldingen).
• Er mogen geen tabellen worden gebruikt (zie beperkingen bij tabellen).
• Letterkleur, tekengrootte en lettertype mogen niet vast gedefinieerd zijn (zie richtlijnen voor tekst).

Basis-HTML voor woordenboeken

Opmaak

Frameset-element

Alle woordenboeken moeten een <mbp:frameset>-element hebben als eerste onderliggende element van het <body>-element. Dit frameset-element bevat alle <idx:entry>-elementen van het woordenboek.

De naamruimte voor dit <mbp:frameset>-element is

xmlns:mbp="https://kindlegen.s3.amazonaws.com/AmazonKindlePublishingGuidelines.pdf" en het moet worden gedeclareerd in het <html>-hoofdelement van het XHTML-document.

Voorbeeld:

Trefwoordenindex

Als je een alfabetische index van trefwoorden wilt maken, moet je speciale tags gebruiken die geen standaard-HTML zijn. De bron bestaat nog steeds uit normale XHTML met deze toegevoegde <idx>-markeringen.

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

De tag <idx:entry> geeft het bereik van elke te indexeren term aan. In een woordenboek moet elk trefwoord met de bijbehorende definitie(s) worden geplaatst tussen <idx:entry> en </idx:entry>. Elk type HTML mag binnen deze tag worden geplaatst.

De tag <idx:entry> kan de kenmerken name, scriptable en spell hebben. De kenmerk name geeft de index aan waartoe het trefwoord behoort. De waarde van het kenmerk name moet hetzelfde zijn als de naam voor Default Lookup Index in de OPF. Het kenmerk scriptable zorgt dat de term toegankelijk is vanuit de index. De enige mogelijke waarde voor het kenmerk scriptable is "yes". Met het kenmerk spell kan worden gezocht met jokertekens en kan een spellingcorrectie worden uitgevoerd tijdens het opzoeken van woorden. De enige mogelijke waarde voor het kenmerk spell is "yes".

Voorbeeld:

De tag <idx:entry> kan ook het kenmerk id hebben met een opeenvolgend id-nummer voor de term. Dit nummer moet overeenkomen met de waarde van het kenmerk id in een anker-tag die wordt gebruikt voor koppelingen met kruisverwijzingen:

Voorbeeld:

Het id-nummer van de term wordt niet gebruikt om in het boek te zoeken. In plaats daarvan moet de woordvorm die moet worden geïndexeerd in het <idx:orth>-element worden opgenomen zoals beschreven in de volgende secties.

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

De tag <idx:orth> wordt gebruikt om het label aan te geven dat in de indexlijst wordt weergegeven en dat als trefwoord kan worden gezocht. Dit is de tekst die gebruikers in het zoekvak kunnen invoeren om een term te vinden.

Voorbeeld:

Hier volgt een voorbeeld van een zeer eenvoudige term die deel kan uitmaken van een Nederlands woordenboek. In dit voorbeeld wordt het woord 'stoel' weergegeven in de indexlijst en kan het door gebruikers worden gezocht.

Voorbeeld:

Het kenmerk value kan worden gebruikt in de tag <idx:orth> om een verborgen label in de term op te nemen. Dit kenmerk zorgt ervoor dat de opzoekfunctie werkt in het geval van speciale opmaak die vaak wordt gebruikt voor trefwoorden in woordenboeken.

Voorbeeld:

Als het trefwoord in het woordenboek moet worden weergegeven met een cijfer in superscript om homoniemen aan te geven, met een symbool voor geregistreerd handelsmerk, met punten die lettergrepen scheiden of met andere toegevoegde symbolen, moet deze speciale opmaak worden weergegeven in de tekst tussen de <idx:orth>-tags, maar niet in de tekst van het value-kenmerk . De tekst in het kenmerk value moet precies overeenkomen met de vorm die voor opzoeken wordt gebruikt. Als het kenmerk value niet is opgegeven, wordt de term tussen de <idx:orth>-tags geïndexeerd voor de zoekfunctie. Als de tekst tussen de <idx:orth>-tags punten, cijfers in superscript of andere symbolen bevat, werkt de zoekfunctie in het boek niet tenzij een verborgen label met de opzoekvorm wordt opgegeven in het kenmerk value.

Voorbeeld:

Als het woordenboek gebruikmaakt van meer dan een orthografisch script, kan het kenmerk format van de <orth>-tag worden gebruikt om elk script te identificeren en de index te maken.

Voorbeeld:

Naast deze primaire index van trefwoorden voor alle termen in het woordenboek, is voor zoeken in een boek ook een aanvullende index met verbogen vormen van elk trefwoord vereist. Als je een verborgen index met verbuigingen wilt bouwen, moet je aanvullende gegevens als volgt nesten in de tag <idx:orth>.

Verbuigingen voor woordenboeken

Woordenboeken moeten zo worden opgebouwd dat meerdere verbogen vormen van één basiswoord naar dezelfde term leiden. Er moet een volledige lijst van verbogen woordvormen voor elk trefwoord worden gegeven. Als een term meerdere schrijfwijzen gebruikt, moet je aparte verbuigingen geven voor elke schrijfwijze.

Verbuigingsindex

Je maakt de verborgen verbuigingsindex door de gegevens voor de verbogen woordvormen te plaatsen tussen de tags <idx:infl> en <idx:iform /> die zijn genest in het element <idx:orth>. Deze index is niet rechtstreeks doorzoekbaar door de gebruiker, maar wordt gebruikt om te zoeken in het boek.

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

Het <idx:infl>-element kan meerdere <idx:iform />-elementen bevatten. De <idx:iform />-elementen zijn altijd lege elementen en worden alleen gebruikt voor kenmerken, niet voor zichtbare content. Het kenmerk value geeft de verbogen vormen aan die samen de verbuigingsindex vormen.

Voorbeeld:

De tags <idx:infl> en <idx:iform /> en het kenmerk value zijn verplicht. Het <idx:infl>-element kan ook een optioneel inflgrp-kenmerk hebben om de woordsoort aan te geven, en het <idx:iform />-element kan een optioneel name-kenmerk hebben om verbogen vormen aan te geven. Voor talen die uitgebreide verbuigingen gebruiken, zal de grootte van de verbuigingsindex toenemen als al deze optionele categorieën worden toegevoegd, waardoor het opzoeken van woorden langer duurt.

Voorbeeld:

De vermelde kenmerken van de tag <idx:iform /> zijn onzichtbaar voor de gebruiker, maar bieden de informatie die nodig is om tijdens het zoeken van verbogen vormen te verwijzen naar de bijbehorende trefwoorden. Als je informatie over de woordsoort of verbogen vormen aan de gebruiker wilt geven, moet je aanvullende tekst opnemen in de hoofdtekst van de term (bijvoorbeeld naast de definities en voorbeelden).

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

Net als de tag <idx:infl> is de tag <idx:key> bedoeld om een term in de index te kunnen opzoeken door te zoeken naar een alternatieve woordvorm. Als er echter <idx:key>-tags in een Kindle-woordenboek staan, kan dit leiden tot instabiliteit van de opzoekfunctie en kan dit de werking van de parameter voor exacte overeenkomst verstoren. Daarom wordt het gebruik van de tag <idx:key> in Kindle-woordenboeken afgeraden. Plaats de alternatieve opzoekvormen in plaats hiervan tussen de tags <idx:infl> en <idx:iform />.

Parameter voor exacte overeenkomst

Standaard gebruikt het Kindle-apparaat een 'fuzzy' algoritme voor het zoeken naar diakritische tekens tijdens het opzoeken van woorden. Talen die diakritische tekens gebruiken om onderscheid te maken tussen verschillende woordvormen, moeten het kenmerk exact="yes" in de tag <idx:iform /> gebruiken om een exacte overeenkomst van diakritische tekens tijdens het opzoeken af te dwingen.

Voorbeeld:

Een woordenboek opbouwen met KindleGen

Wanneer je een woordenboek opbouwt met KindleGen via de opdrachtregel, gebruik je de volgende syntaxis:

Als de woordenboektermen zijn opgeslagen in één zeer groot XHTML-bestand, kan KindleGen het woordenboek mogelijk niet maken. Als het woordenboek niet kan worden gemaakt, kun je dit probleem waarschijnlijk oplossen door de inhoud van het woordenboek te splitsen in twee of meer XHTML-bestanden.

Zie richtlijnen voor het gebruik van KindleGen.

Kindle-woordenboeken testen

Opmaak testen

Amazon raadt aan te controleren of het geconverteerde woordenboek correct is opgemaakt, zodat de gebruiker een goede visuele ervaring krijgt:

• Controleer de opmaak van de definities door het woordenboek door te bladeren en verschillende definities te lezen. (Je kunt de opmaak van het woordenboek controleren met Kindle Previewer of op een Kindle-apparaat. Om de opzoekfunctie te testen, moet je wel een e-reader gebruiken.)
• Controleer of er geen woorden zijn met niet-ondersteunde tekens, woorden niet onjuist worden afgebroken of samengevoegd en kijk of tekens met accenten, symbolen en uitspraakaanwijzingen correct worden weergegeven, enzovoort.
• Controleer of er geen typefouten zijn.
• Controleer of koppelingen (indien aanwezig) correct werken. (Koppelingen zijn uitgeschakeld in het opzoekvenster in het boek, maar horen te werken in het woordenboek zelf.)
• Als er afbeeldingen worden gebruikt, moet je controleren of deze afbeeldingen duidelijk en leesbaar zijn.
• Controleer of de letterkleur en het lettertype niet vast zijn gedefinieerd.

Zoekfunctie testen

Amazon raadt aan te controleren of definities correct worden weergegeven wanneer het woordenboek wordt gebruikt om woorden op te zoeken in andere boeken. Dit testonderdeel kan alleen worden uitgevoerd op e-readers (niet met Previewer), omdat de gebruiker alleen op een e-reader het standaardwoordenboek voor opzoeken kan instellen.

• Laad het woordenboek op de e-reader. Sluit hiervoor de Kindle met een USB-naar-mini-USB-kabel aan op je computer. De computer moet het apparaat detecteren. In het venster dat verschijnt, moet je een map genaamd Documents zien. Plaats het woordenboekbestand in deze map en koppel de Kindle los van de computer.
• Stel het testwoordenboek in als standaardwoordenboek voor de opzoekfunctie:
  • Kindle Paperwhite: Ga naar Startscherm > Menu > Instellingen > Apparaatopties > Taal en woordenboeken > Woordenboeken > [Brontaal]
• Zoek diverse woorden op om te kijken of een definitie wordt weergegeven. Open een ander boek dan het woordenboek, selecteer een woord en bekijk de definitie in het opzoekvenster. Als het opzoeken mislukt, moet je de HTML-tags op fouten controleren. Suggesties voor op te zoeken woorden:
  • Vervoegingen van regelmatige en onregelmatige werkwoorden
    • Voorbeeld: wandel, wandelt, wandelen, gewandeld; ga, gaat, gaan, gegaan, ging, gingen
  • Zelfstandige naamwoorden, bijvoeglijke naamwoorden, bijwoorden en hun vervoegingen/verbuigingen
    • Voorbeeld: bureau, bureaus; wolf, wolven; warm, warmer, warmst
  • Gangbare grammaticale conventies en leestekens
    • Voorbeeld: samentrekkingen, weglatingen van een of meer klanken, werkwoorden met onbeklemtoonde voornaamwoorden
• Controleer de indexweergave van het woordenboek. Open hiervoor het woordenboek en begin een woord te typen in het vak Zoeken. Er wordt nu een alfabetische lijst met trefwoorden weergegeven die dynamisch wordt bijgewerkt op basis van de getypte letters. Als de gebruiker een trefwoord selecteert in de indexlijst, wordt de woordenboekterm voor dat trefwoord weergegeven.