Sjabloon:Indexentry
Sjabloondocumentatie
Plaktekst
{{Indexentry
| ABC =
| Nieuw =
| Ind1 =
| Ind2 =
| Ind3 =
| Pag =
| Anker =
| Kol =
| ZieAnker =
| ZieText =
| ZieZoek =
}}
Doel van het sjabloon
Het doel van het sjabloon is bij een boek een index maken. De index wordt in een tabel opgebouwd. De parameter <Nieuw> bepaalt of een nieuwe kolom of een nieuwe rij gestart wordt. De hoogste <Ind?> is de tekst die in de index als link getoond wordt. De eigenlijke link staat naar <Pag>, en eventueel een op die pagina gedefinieerd <Anker>.
De indexentry's worden niet gesorteerd door het sjabloon. De volgorde is gelijk aan de volgorde waarin de entry's worden opgegeven. Voor elke index-entry vindt een sjablooncall plaats.
De gewoonte om bij meerdere entry's onder een hoofdentry deze laatste niet te herhalen wordt niet expliciet ondersteund: in de sjablooncall wordt bijvoorbeeld <Ind1> leeg gelaten. Er wordt dan ook geen regel voor opengelaten (zie Voorbeeld.
Parameters
ABC
Deze parameter plaatst een in de inhoudsopgave bruikbare kop in de kolom.
Anker
In wikibooks kan de kop van een paragraaf gebruikt worden om naar een plaats in de pagina te springen. In het sjabloon Kolommen2 (variabel) kan met de parameter Anker ook zonder een hoofdstukkop een inspringpunt gegenereerd worden.
Ind?
De index wordt in maximaal 3 niveaus opgebouwd. De prameters zijn Ind1, Ind2 en Ind3. Het hoogste niveau wordt als tekst voor de link getoond. De lagere niveaus kunnen wel of niet geladen zijn. Bij niet geladen wordt impliciet aangenomen dat de entry een van de sub-entries is van een eerder getoond hoger niveau
Kol
Deze parameter is alleen actief in combinatie met Nieuw = "Fst". De index wordt in een tabel opgebouwd. In de sjablooncall met " Nieuw = Fst" wordt de opmaak van de tabel vastgelegd, inclusief het aantal kolommen. Deze parameter bepaalt het aantal kolomman.
Nieuw
Deze parameter bepaalt de lay-out van de index. De indextabel wordt over de volle breedte van de pagina opgezet. Voor de parameter <Nieuw> zijn vijf waarden gedefinieerd. Deze waarden zijn hoofdletter gevoelig!
- Nieuw = Dbl
- Dbl voor Double. Bij een handmatig ingevulde bronlijst bestaat de mogelijkheid van doublures. Deze kunnen tijdens het automatische deel opgespoord worden, maar dan zijn rijen lastig te verwijderen. Door deze code wordt de sjablooncall zonder resultaat afgerond.
- Nieuw = Fst
- Fst voor First. Dit entry is het allereerste entry. Naast de startcode voor een rij wordt ook de openingscode voor de tabel geplaatst.
- Nieuw = Lst
- Lst voor Last. De entry is de allerlaatste in de tabel. De afsluitende tabelcode wordt geplaatst.
- Nieuw = Kol
- Dit entry is het eerste in een nieuwe kolom.
- Nieuw = Rij
- Dit item is het eerste item in een nieuwe tabelrij.
- Nieuw = <leeg> of een andere waarde dan Fst, Lst, Kol of Rij
- Het item wordt direct onder het vorige item geplaatst.
Pag
De pagina waarheen verwezen moet worden
ZieAnker
Om constructies als Zie Elementen mogelijk te maken zijn de parameters ZieText, ZieZoek en ZieAnker aanwezig. ZieAnker (met hoofdletter 'Z' en hoofdletter 'A') is het label waarnaar gesprongen moet worden. Labels dienen uniek te zijn.
ZieText
Om constructies als Zie Elementen mogelijk te maken zijn de parameters ZieText, ZieZoek en ZieAnker aanwezig. ZieText (met hoofdletter 'Z' en hoofdletter 'T') is de tekst die in de verwijzende entry gebruikt wordt om in het scherm te tonen. Deze parameter moet geladen zijn om de Zie-constructie te kunnen gebruiken.
ZieZoek
ZieZoek (met beide hoofdletters 'Z') heeft alleen effect als ook ZieText geladen is. Deze parameter is optioneel. Als hij aanwezig is, wordt bij aanklikken een sprong in de indexpagina gemaakt naar de locatie waarvan de parameter ZieAnker de zelfde waarde heeft als de hier opgegeven ZieZoek-waarde. Ontbreekt deze parameter, maar is ZieText wel gedefinieerd, dan wordt de link rood weergegeven.
Voorbeeld
Code
{{Indexentry|Nieuw = Fst| Kol = 2| Ind1 = Gebak| Ind2 = Appelflappen| Ind3 = Beslag| Pag = Appelflappen | Anker = Recept}}
{{Indexentry|Nieuw = | Ind1 = | Ind2 = Oliebollen| Ind3 = | Pag = Oliebollen | Anker = }}
{{Indexentry|Nieuw = |Ind1 = | Ind2 = | Ind3 = Beslag| Pag = Oliebollen | Anker = Beslag}}
{{Indexentry|Nieuw = Kol|Ind1 = Oud en nieuw| Ind2 = Vuurwerk| Ind3 = Gillende keukenmeid | Pag = Vuurwerk | Anker = Knalvuurwerk}}
{{Indexentry|Ind1 = | Ind2 = | Ind3 = Rotje | Pag = Vuurwerk | Anker = Knalvuurwerk}}
{{Indexentry|Nieuw = Lst|Ind1 = | Ind2 = | Ind3 = Voetzoeker | Pag = Vuurwerk | Anker = Knalvuurwerk}}
Resultaat
| Gebak Appelflappen Beslag | Oud en nieuw Vuurwerk Gillende keukenmeid Voetzoeker |