Komponenten lister overskrifter som har formatering "Overskrift 2" (h2) eller "Overskrift 3" (h3) i starten av innholdsfeltet. Innholdfortegnelsen består av hopplenker som tar brukeren ned til valgte overskrift. Innholdsfortegnelsen skal bare brukes til lange dokumenter.
Anbefalt bruk
Innholdsfortegnelse brukes til lange dokumenter, der det er viktig for brukeren å få raskt oversikt over innholdet og kunne hoppe til ønsket avsnitt. Eksempler er brukerveiledninger eller lange saksdokumenter.
Anbefalt måte å legge inn på
$<slettmeg>{resource:toc}
OBS! Fjern "<slett meg>" i koden ovenfor for å få koden til å virke.
Endre tittel
Tittelen settes automatisk til "Innholdsfortegnelse". Hvis du vil ha en annen tittel, skriver du "title=[nytittel]" etter "${resource:toc" - slik:
${resource:toc title=[Dagsorden]}
Kun listing av Overskrift 2
Du kan få komponenten som lager en automatisk innholdsfortegnelse til kun å liste øverste nivå av overskrifter ("Overskrift 2") ved å legge komponenten på denne måten
<div class="vrtx-toc-only-one-level">
${resource:toc}
</div>
Endre skriftstørrelse
Det finnes noen spesialklasser du kan legge inn i kildekoden for å styre utseende til innholdsfortegnelsen.
Redusere størrelsen på overskriften til innholdsfortegnelsen fra h2 til h3
<div class="vrtx-toc-style-like-h3">
${resource:toc}
</div>
Redusere størrelsen på overskriften til innholdsfortegnelsen fra h2 til h4
<div class="vrtx-toc-style-like-h4">
${resource:toc}
</div>
Lenke til anker
Hvis du skal lenke til et anker fra en annen side, anbefales det å lage et anker manuelt ved å bruke anker-knappen, i stedet for å lenke til et anker som er opprettet av innholdsfortegnelse-komponenten. Grunnen til det er at anker som blir opprettet av komponenten oppdateres automatisk. "#toc3" blir for eksempel til "#toc4" hvis det legges inn en ny overskrift.