Innehållsförteckning, komponent table-of-contents-component
Innehållsförteckningskomponenten skapar en innehållsförteckning som baseras på rubrikerna i sidinnehållet, vilket gör att läsarna snabbt kan navigera på sidan.
Användning usage
Innehållsförteckningskomponenten ger besökare möjlighet att snabbt navigera i sidans innehåll via en effektivt genererad innehållsförteckning baserat på rubrikerna för sidinnehållet.
- ToC genereras på serversidan.
- Den cachelagras fullständigt av dispatchern för snabb leverans.
- Det fungerar med alla komponenter på sidan, inte bara med kärnkomponenterna.
I redigeringsdialogrutan kan innehållsförfattaren definiera intervallet med titlar som ska användas i ToC. Med hjälp av designdialogrutan kan mallskaparen ange standardvärdet för rubrikerna när en innehållsförfattare lägger till en innehållsförteckningskomponent på en sida, samt begränsa titlar som ingår i innehållsförteckningen baserat på klassnamn.
Version och kompatibilitet version-and-compatibility
Den aktuella versionen av innehållsförteckningskomponenten är v1, som introducerades i version 2.20.0 av grundkomponenterna i maj 2022, och som beskrivs i det här dokumentet.
Följande tabell visar alla versioner av komponenten som stöds, de AEM versionerna som komponenterna är kompatibla med och länkar till dokumentation för tidigare versioner.
Mer information om versioner och versioner av kärnkomponenter finns i dokumentet Core Components Versions.
Teknisk information technical-details
Den senaste tekniska dokumentationen om innehållsförteckningskomponenten finns på GitHub.
Mer information om hur du utvecklar kärnkomponenter finns i dokumentationen för kärnkomponentutvecklare.
Dialogrutan Redigera edit-dialog
I redigeringsdialogrutan kan innehållsförfattaren definiera intervall med titelnivåer som innehållsförteckningskomponenten ska återge som en ToC.
Listtyp - Det här alternativet anger om listan ska vara en punktlista eller en numrerad lista.
-
Rubrikstartnivå - Det här alternativet definierar den högsta nivån med titlar som innehållsförteckningskomponenten ska återge.
-
Titelstoppnivå - Det här alternativet definierar den lägsta nivån med titlar som innehållsförteckningskomponenten ska återge.
-
ID - Med det här alternativet kan du styra den unika identifieraren för komponenten i HTML och i datalagret.
- Om inget anges genereras ett unikt ID automatiskt åt dig och du hittar det genom att granska den resulterande sidan.
- Om ett ID anges är det författarens ansvar att se till att det är unikt.
- Om du ändrar ID:t kan det påverka spårningen av CSS, JS och datalager.
Designdialogruta design-dialog
Med hjälp av designdialogrutan kan mallskaparen ange standardvärdet för namnområdet för innehållsförteckningskomponenten samt begränsa rubrikerna i innehållsförteckningen baserat på klassnamn.
Fliken Egenskaper properties-tab
-
Begränsa listtyp - Det här alternativet definierar den typ av lista som komponenten ska generera. Om du väljer det här alternativet begränsas innehållsförfattarens möjlighet att välja en annan listtyp.
-
Begränsa startnivån - Det här alternativet definierar den högsta titelnivå som innehållsförfattaren kan välja för att definiera ToC.
-
Begränsa stoppnivån - Det här alternativet definierar den lägsta titelnivån som innehållsförfattaren kan välja för att definiera ToC.
-
Inkludera klassnamn - Om det här alternativet anges beaktas endast titlar med de angivna klassnamnen eller som finns i element i de angivna klassnamnen av komponenten Innehållsförteckning.
- Tryck eller klicka på ikonen Lägg till för att lägga till ett eller flera klassnamn.
- Tryck eller klicka på ikonen Ta bort bredvid ett klassnamn för att ta bort den.
-
Ignorera klassnamn - Om det här alternativet anges ignoreras rubriker med de angivna klassnamnen eller som finns i element i de angivna klassnamnen av innehållsförteckningskomponenten.
- Tryck eller klicka på ikonen Lägg till för att lägga till ett eller flera klassnamn.
- Tryck eller klicka på ikonen Ta bort bredvid ett klassnamn för att ta bort den.
Fliken Format styles-tab
Innehållsförteckningskomponenten stöder AEM Style System.
Adobe-klientdatalager data-layer
Innehållsförteckningskomponenten stöder datalagret Adobe Client.