Difference between revisions of "Template:TOC limit/doc"

From Summertime Saga Wiki
Jump to: navigation, search
m
m
Line 50: Line 50:
 
=== Conflicts ===
 
=== Conflicts ===
  
This template does not interact well with the {{tl|TOC right}}, {{tl|TOC left}}, {{tl|TOC center}} templates. To achieve the correct effect, use those with a limit parameter. For example, {{tlx|TOC right|2=limit=2}} has the effect that {{tlx|TOC right}} and {{tlx|TOC limit|2}} would have—if they worked together.
+
This template does not interact well with the {{tl|TOC right}} template. To achieve the correct effect, use those with a limit parameter. For example, {{tlx|TOC right|2=limit=2}} has the effect that {{tlx|TOC right}} and {{tlx|TOC limit|2}} would have—if they worked together.
  
 
Due to the way the TOC is generated with MobileFrontend (mobile/tablet view) this template does not currently affect how the mobile TOC is displayed.
 
Due to the way the TOC is generated with MobileFrontend (mobile/tablet view) this template does not currently affect how the mobile TOC is displayed.
  
 
[[Category:Documentation subpages]]
 
[[Category:Documentation subpages]]

Revision as of 16:36, 20 June 2019

This template inserts a Table of Contents which omits subheadings beyond a certain depth. The table obeys the same layout rules as the __TOC__ magic word. Omitted sections still have section edit links in the article body; the main use for this template is situations where you want section edit links for ease of editing but don't want to clutter the table of contents.

Usage

Template:Tlx or Template:Tlx

The template defaults to including second- and third-level headings, e.g. those numbered "1" and "1.1" in the TOC. (Note: The first-level heading on a page is, by default, the page title.)

You can specify a different limit by adding a header level:

Template:Tlx

4 allows for fourth-level headings, e.g. "1.1.1", but omits any subheadings below that from the TOC.

The template works by hiding the lower levels with CSS.

TOC levels versus wikitext header levels

The heading levels in the TOC normally correspond to the header levels in the wikitext, so a "== Level-2 header ==" will normally generate the first-level ("1") TOC headings, a "=== Level-3 header ===" will normally generate the second-level ("1.1") TOC headings, and so on. This correspondence does not hold if the page contains "= Level-1 headers =" or skips header levels. For example, wikitext like this:

== Level-2 heading (A) ==
=== Level-3 heading (B) ===
== Level-2 heading (C) ==
====== Level-6 heading (D) ======
= Level-1 heading (E) =
== Level-2 heading (F) ==
=== Level-3 heading (G) ===

will generate a TOC like this:

Contents
  • 1 Level-2 heading (A)
    • 1.1 Level-3 heading (B)
  • 2 Level-2 heading (C)
    • 2.1 Level-6 heading (D)
  • 3 Level-1 heading (E)
    • 3.1 Level-2 heading (F)
      • 3.1.1 Level-3 heading (G)

Using {{TOC limit}} on this page would not hide header D, because even though it is a level-6 heading it is shown at the second level in the TOC. And it would hide header G even though it is a level-3 heading just like header B, because header G is shown at the third level in the TOC while header B is shown at the second level.

Conflicts

This template does not interact well with the Template:Tl template. To achieve the correct effect, use those with a limit parameter. For example, Template:Tlx has the effect that Template:Tlx and Template:Tlx would have—if they worked together.

Due to the way the TOC is generated with MobileFrontend (mobile/tablet view) this template does not currently affect how the mobile TOC is displayed.