Denna sida beskriver syftet och formatet för *.devhelp2-indexfiler.
En bok (se ) innehåller en indexfil. Indexfilen har filändelsen .devhelp2 och har ett XML-format.
Siffran ”2” i filändelsen *.devhelp2 beror på att det är den andra versionen av filformatet. Den första versionen av formatet, med filändelsen *.devhelp, är föråldrad och stöd för den kan tas bort från Devhelp i framtiden. När Devhelp läser av filsystemet för att hitta böcker vid programstart så skriver det ett varningsmeddelande i terminalen för varje bok som använder ett föråldrat format.
Indexfilen innehåller främst:
Bokstrukturen (som en innehållsförteckning).
En lista över symboler (funktioner, typer, makron, signaler, egenskaper, …).
Dessa innehåller länkar till HTML-filerna för att nå motsvarande sidor och symboler.
I Devhelp visas bokstrukturen i sidopanelen. Sökningen i sidopanelen visar resultat som hittats i indexfilerna.
Tyvärr är inte XML-filformatet för *.devhelp2 väldokumenterat. Det finns fortfarande en förhoppning att detta ska lösas i en nära framtid. Under tiden rekommenderar vi att titta på vad GTK-Doc genererar. För den mest precisa definitionen över vad Devhelp stöder kan du läsa källkoden för tolken och API-referensen för Devhelp.