Kwicdex, een indexeer hulpmiddel

Intro

Kwicdex is een klein Windows hulpprogramma om een zogenaamde KWIC-index te maken. Het acroniem KWIC staat voor 'keyword in context'. In een KWIC-index wordt niet één sleutelwoord ('keyword') geïndexeerd, maar een 'indexterm', die uit meerdere elementen (woorden) bestaat. Alle elementen komen in die index als sleutelwoord voor, vergezeld van de andere elementen uit die indexterm. Verder is in het programma voorzien, dat niet naar paginanummers wordt verwezen, maar naar zelf op te geven referenties, zoals b.v. een folio- of actenummer. Het is mogelijk tegelijk meerdere indices te genereren. Het uitvoerbestand is in een 'komma' delimited format, en kan in een spreadsheet worden ingelezen, om daarin nader bewerkt (b.v. gesorteerd) te worden. Het programma, de bijbehorende helpfile, en een voorbeeld invoerbestandje, zijn te downloaden van mijn site http://www.grijsbaard.nl/ . Verkoop en verspreiding door derden (op welke manier dan ook) is, behoudens met schriftelijke toestemming, evenwel verboden.

drs Huib J. Plankeel

Inleiding

Kwicdex is een onder 32-bit Windows (dus Win98 en hoger, al heb ik alleen W98 en W2000 getest) draaiend programma. Het is ontstaan, omdat ik voor mijn bewerking van de oude Zierikzeese schepenacten iets nodig had, om een fatsoenlijke (papieren) index daarop te kunnen maken. De indexeer-mogelijkheden van de gebruikelijke tekstverwerkers zijn daartoe niet toereikend, met name omdat zo'n index naar pagina-nummers verwijst. Bij tientallen namen op een pagina zou de gebruiker flink moeten zoeken om de acte te vinden, waarin 'Janssen' wordt vermeld. Ook is de methode, om een ingang in de index op te nemen, tamelijk tijdrovend, wanneer we praten over elf duizend indextermen. Vandaar dat ik zelf wat heb geprogrammeerd in Delphi.

Installatie

Het programma maakt geen gebruik van enig ander bestand en is dus simpel te gebruiken, zonder dat er gevaar bestaat voor het verstoren van het computersysteem. Na het downloaden van de bestanden (via de rechter muisknop) in een zelf aangemaakte map 'Kwicdex' in de map c:\program files\ (of een andere map naar keuze) kan men een link op het bureaublad aanbrengen door met de rechter muisknop op het bureaublad te klikken, te kiezen voor New, Shortcut [of de overeenkomstige Nederlandse benamingen] en dan via browse [bladeren] het programma Kwicdex.exe te selecteren. De help staat in een aparte pdf-file KwicdexHelp.pdf en kan via het programma opgeroepen worden, mits de helpfile in dezelfde map staat als het programma.

Uitgangspunten en werkwijze

Het programma gaat uit van genummerde 'records'. Dit kunnen acten zijn, of paragrafen, alinea's, en wat niet meer. De enige voorwaarde is dat het begin en eind daarvan gemarkeerd kunnen worden, en dat direct aan het begin iets staat, dat als verwijzing naar het record kan dienen. Desgewenst kan aan het eind van het record nog een extra (tweede) verwijzing opgenomen zijn. Binnen zo'n record kunnen meerdere termen (of woordreeksen) gemarkeerd worden, elk met desgewenst een aparte kleur of anderszins ( b.v. vet). De enige beperking is, dat een zestal tekens (de 'stuurtekens') niet elders in de tekst mogen voorkomen.
Dat biedt een grote flexibiliteit:
1. Elk stuk tekst kan een 'record' zijn, mits als zodanig gemarkeerd en tenminste aan het begin van een soort 'nummer' voorzien.
2. Elk stuk tekst kan geïndexeerd en aan een bepaalde indexsoort worden gekoppeld.
3. Het groot aantal soorten indexen is mogelijk.

Als invoer voor het programma maak ik gebruik van een bewerkt html-bestand. Het grote voordeel van html is, dat html-elementen, zoals b.v. een paragraaf, zowel een begin- als een eind-markering hebben.
Deze bewerking betreft het verwijderen van enkele stukken tekst en verder een aantal zoek en vervang acties. Het html-bestand is weer het (save as) resultaat van een bewerking van (een kopie van) het te indexeren document, waarin alle te indexeren termen met een kleur (of anders) zijn gemarkeerd. De werkzijde is dus als volgt:
1. Maak een kopie van het te indexeren document.
2. Zorg ervoor, dat daarin 'records' te onderscheiden zijn, en dat er geen Kwicdex-'stuurtekens' in voorkomen.
3. Markeer daarin alle te indexeren termen met een kleur of anders. (Gebruik voor elke indexsoort een andere kleur.)
4. Sla dit bestand op als html-document.
5. Verander de extensie van dit html-bestand in '.txt'.
6. Open dit bestand als tekstbestand in de tekstverwerker.
7. Vervang de nodige html-codes door de voor Kwicdex benodigde codes, en verwijder de rest.
8. Stel in Kwicdex de opties in en open dan in Kwicdex het zo bewerkte bestand. Het programma genereert op basis hiervan een indexfile (in komma delimited format).
9. Open (of importeer) de gemaakte '.csv' indexfile in een spreadsheet voor verdere sortering en bewerking.

Het lijkt omslachtig, maar dat valt reuze mee. Het markeren moet zo wie zo gebeuren. Het zoeken/vervangen van de html-codes door Kwicdex-codes is tamelijk simpel, omdat html goed gestandaardiseerd is. Bovendien is de html-export (per tekstverwerker!) tamelijk eensluidend, zodat men eigenlijk alleen voor het eerste document wat beter moet kijken, wat door wat vervangen moet worden. Daarna zou een zoek/vervang macro een groot deel van het werk kunnen doen. En de verwerking in de spreadsheet is tenslotte nodig om de gewenste sortering van de index te realiseren.

Verdere toelichting

Voor verdere toelichting verwijs ik naar de helpfile KwicdexHelp.pdf.