Difference: VarTOC2 (1 vs. 7)

Revision 716 Jun 2014 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"

TOC{"Topic"} -- table of contents

Changed:
<
<
  • Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC. An abbreviated heading can be shown in the TOC, such as "---++ text!! this is excluded from TOC".
>
>
  • Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC. An abbreviated heading can be shown in the TOC, such as "---++ text!! this is excluded from TOC".
 
  • Syntax: %TOC{"SomeTopic" ...}%
  • Supported parameters:
    Parameter: Description: Default:
    "TopicName" Topic name Current topic
    web="Name" Name of web Current web
Changed:
<
<
depth="2" Limit depth of headings shown in TOC 6
>
>
depth="2" Limit depth of headings shown in TOC TOC_MAX_DEPTH if defined. Otherwise 6
mindepth="2" Specify the minimum depth of headings TOC_MIN_DEPTH if defined. Otherwise 1
 
title="Some text" Title to appear at top of TOC none (TOC_TITLE setting)
style="..." Style to apply to the TOC none (TOC_STYLE setting)
  • Example: %TOC{depth="2"}%

Revision 601 Oct 2013 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"

TOC{"Topic"} -- table of contents

Line: 6 to 6
 
Changed:
<
<
"TopicName" topic name Current topic
>
>
"TopicName" Topic name Current topic
 
web="Name" Name of web Current web
depth="2" Limit depth of headings shown in TOC 6
Changed:
<
<
title="Some text" Title to appear at top of TOC none
>
>
title="Some text" Title to appear at top of TOC none (TOC_TITLE setting)
style="..." Style to apply to the TOC none (TOC_STYLE setting)
 
  • Example: %TOC{depth="2"}%
Changed:
<
<
  • Example: %TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
>
>
 

Revision 507 Jul 2010 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"

TOC{"Topic"} -- table of contents

Line: 12 to 12
 
title="Some text" Title to appear at top of TOC none
  • Example: %TOC{depth="2"}%
  • Example: %TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
Changed:
<
<
>
>

Revision 426 May 2010 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"

TOC{"Topic"} -- table of contents

Changed:
<
<
  • Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC
>
>
  • Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC. An abbreviated heading can be shown in the TOC, such as "---++ text!! this is excluded from TOC".
 

Revision 324 Apr 2009 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"

TOC{"Topic"} -- table of contents

Line: 13 to 13
 
Deleted:
<
<
  • TIP Hint: TOC will generate links to the headings, so when a reader clicks on a heading it will jump straight where that heading is anchored in the text. If you have two headings with exactly the same text, then their anchors will also be identical and they won't be able to jump to them. To make the anchors unique, you can add an invisible HTML comment to the text of the heading. This will be hidden in normal view, but will force the anchors to be different. For example, ---+ Heading <!--5-->.
 
Deleted:
<
<

Revision 227 Mar 2005 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"
Deleted:
<
<
 

TOC{"Topic"} -- table of contents

  • Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC
  • Syntax: %TOC{"SomeTopic" ...}%
Line: 12 to 11
 
depth="2" Limit depth of headings shown in TOC 6
title="Some text" Title to appear at top of TOC none
  • Example: %TOC{depth="2"}%
Changed:
<
<
  • Example: %TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
>
>
  • Example: %TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
 
  • Example: see TWiki:Sandbox.TestTopicInclude
  • TIP Hint: TOC will generate links to the headings, so when a reader clicks on a heading it will jump straight where that heading is anchored in the text. If you have two headings with exactly the same text, then their anchors will also be identical and they won't be able to jump to them. To make the anchors unique, you can add an invisible HTML comment to the text of the heading. This will be hidden in normal view, but will force the anchors to be different. For example, ---+ Heading <!--5-->.
Changed:
<
<
>
>
 

Revision 127 Mar 2005 - TWikiContributor

Line: 1 to 1
Added:
>
>
META TOPICPARENT name="TWikiVariables"

TOC{"Topic"} -- table of contents

  • Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC
  • Syntax: %TOC{"SomeTopic" ...}%
  • Supported parameters:
    Parameter: Description: Default:
    "TopicName" topic name Current topic
    web="Name" Name of web Current web
    depth="2" Limit depth of headings shown in TOC 6
    title="Some text" Title to appear at top of TOC none
  • Example: %TOC{depth="2"}%
  • Example: %TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
  • Example: see TWiki:Sandbox.TestTopicInclude
  • TIP Hint: TOC will generate links to the headings, so when a reader clicks on a heading it will jump straight where that heading is anchored in the text. If you have two headings with exactly the same text, then their anchors will also be identical and they won't be able to jump to them. To make the anchors unique, you can add an invisible HTML comment to the text of the heading. This will be hidden in normal view, but will force the anchors to be different. For example, ---+ Heading <!--5-->.
  • Related: TOC
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.VarTOC2.