Documentation update.

git-svn-id: svn://pmwiki.org/pmwiki/trunk@3593 524c5546-5005-0410-9a3e-e25e191bd360

1 files changed, 5 insertions, 5 deletions

diff --git a/wikilib.d/PmWiki.TableOfContents b/wikilib.d/PmWiki.TableOfContents
index 4e0a309c..e4bbf339 100644
--- a/wikilib.d/PmWiki.TableOfContents
+++ b/wikilib.d/PmWiki.TableOfContents
@@ -1,11 +1,11 @@
-version=pmwiki-2.2.120 ordered=1 urlencoded=1
+version=pmwiki-2.2.122 ordered=1 urlencoded=1
 author=Petko
 charset=UTF-8
-csum=gender neutral
+csum=grammar
 ctime=1567101340
 name=PmWiki.TableOfContents
-rev=10
+rev=11
 targets=PmWiki.LayoutVariables,Cookbook.AutoTOC
-text=(:title Table of contents:)(:Audience: authors (basic) :)%0a(:Summary:Basic automatic table of contents and numbered headings:)%0aA basic table of contents (TOC) and Numbered headings is included in PmWiki 2.2.119 and can be enabled with the following in config.php:%0a%0a  $PmTOC['Enable'] = 1;%0a%0aThe feature is based on the recipe Cookbook:AutoTOC but is somewhat simpler. %0a%0a* The table of contents is automatic, there is no need to add some markup in the wiki page.%0a* It is inserted right before the first heading in the wiki page.%0a* By default, only pages with 3 or more headings will have a table of contents.%0a* The visitors can close and open the table of contents, and their preferences will be remembered in "localStorage".%0a* The feature can automatically number the headings in the page.%0a* Headings in hidden sections ("comment" wikistyle, "display:none") will not be included in the TOC.%0a* Headings with the [@%25block notoc%25@] class will not be included in the TOC.%0a* Headings in [@(:markup:)@] blocks are ignored.%0a%0aThe following directives in the wiki page can control the above features:%0a%0a* [@(:toc:)@]  the table of contents will be inserted at this position (rather than the default one), even if there are less than 3 headings in the page.%0a* [@(:notoc:)@]  no table of contents will appear on the page, even if there are 3 or more headings, or a [@(:toc:)@] directive.%0a%0aThe TOC will use anchors or identifiers of the headings from the page, if they exist, otherwise it will create a new identifier (hash) based on the structure of the page. The following markups will all create a link with the anchor @@PageUrl%25blue%25#here%25%25@@:%0a%0a* @@!! Heading with id %25blue%25[=%25block id=here%25=]%25%25@@%0a* @@!! Heading with inline anchor %25blue%25[=[[#here]]=]%25%25@@, or%0a* @@!! %25blue%25[=[[#here]]=]%25%25 Heading with inline anchor@@%0a* @@%25blue%25[=[[#here]]=]%25%25\\%0a[=!!  Anchor preceding the heading=]@@%0a%0aIf there is no identifier or anchor with a heading, then the anchor will be in the form @@%25blue%25#toc-1.2.1%25%25@@ where 1.2.1 is the structural path to the section, in this example "Section 1, subsection 2, sub-subsection 1".%0a%0a%0aThe following local configuration (in local/config.php) can control the default settings:%0a%0a* @@$PmTOC['Enable'] = 1; @@# enable TOC, default is disabled.%0a* @@$PmTOC['MaxLevel'] = 6;@@ # levels of headings that are included in the TOC, by default %3ch1> to %3ch6> headings are included. Set to 3 to only include %3ch1> to %3ch3> headings.%0a* @@$PmTOC['MinNumber'] = 3;@@ # minimum number of headings in the page for the TOC to be generated. Pages with few headings are usually short and do not need a TOC. %0a** @@$PmTOC['MinNumber'] = 2; @@# pages with 2+ headings will have a TOC%0a** @@$PmTOC['MinNumber'] = -1; @@# the TOC will not be automatic, only the [@(:toc:)@] directive will create a table of contents in the page.%0a* @@$PmTOC['NumberedHeadings'] = '1.1.1.1.1.1'; @@# the headings will be numbered (default disabled).%0a** You can set here the numerals for the different levels of headings, can be @@1@@ (numeric), @@I@@ or @@i@@ (Roman numerals), @@A@@ or @@a@@ (letters A-Z or a-z). For example, a specification like \\%0a   @@$PmTOC['NumberedHeadings'] = 'I.1.a'; @@ \\%0a   will number the biggest level headings on a page with uppercase Roman numerals (I, II, ...), the second biggest with numbers, the third with lowercase letters (a, b, ...), and the remaining levels (if any) with numbers.%0a* @@$PmTOC['EnableBacklinks'] = 1; @@# insert after the headings "↑" arrows linking back to the table of contents (default disabled).%0a* @@$PmTOC['ParentElement'] = "#wikitext"; @@# the query selector of the parent HTML element where the TOC block to be inserted; by default the TOC is inserted before the first heading; here you can select a different element. If selected, the TOC will be inserted in the element at the top. The [@(:toc:)@] directive in the page can override this element.%0a%0aThe following strings can be translated in XLPage, for example in French:%0a%0a  "Contents" => "Sommaire",%0a  "show"     => "afficher",%0a  "hide"     => "masquer",%0a%0aSee also: Cookbook:AutoTOC. If you previously used AutoTOC you need to disable it when enabling $PmTOC.%0a
-time=1573656257
+text=(:title Table of contents:)(:Audience: authors (basic) :)%0a(:Summary:Basic automatic table of contents and numbered headings:)%0aA basic table of contents (TOC) and Numbered headings are included in PmWiki 2.2.119 and can be enabled with the following in config.php:%0a%0a  $PmTOC['Enable'] = 1;%0a%0aThe feature is based on the recipe Cookbook:AutoTOC but is somewhat simpler. %0a%0a* The table of contents is automatic, there is no need to add some markup in the wiki page.%0a* It is inserted right before the first heading in the wiki page.%0a* By default, only pages with 3 or more headings will have a table of contents.%0a* The visitors can close and open the table of contents, and their preferences will be remembered in "localStorage".%0a* The feature can automatically number the headings in the page.%0a* Headings in hidden sections ("comment" wikistyle, "display:none") will not be included in the TOC.%0a* Headings with the [@%25block notoc%25@] class will not be included in the TOC.%0a* Headings in [@(:markup:)@] blocks are ignored.%0a%0aThe following directives in the wiki page can control the above features:%0a%0a* [@(:toc:)@]  the table of contents will be inserted at this position (rather than the default one), even if there are less than 3 headings in the page.%0a* [@(:notoc:)@]  no table of contents will appear on the page, even if there are 3 or more headings, or a [@(:toc:)@] directive.%0a%0aThe TOC will use anchors or identifiers of the headings from the page, if they exist, otherwise it will create a new identifier (hash) based on the structure of the page. The following markups will all create a link with the anchor @@PageUrl%25blue%25#here%25%25@@:%0a%0a* @@!! Heading with id %25blue%25[=%25block id=here%25=]%25%25@@%0a* @@!! Heading with inline anchor %25blue%25[=[[#here]]=]%25%25@@, or%0a* @@!! %25blue%25[=[[#here]]=]%25%25 Heading with inline anchor@@%0a* @@%25blue%25[=[[#here]]=]%25%25\\%0a[=!!  Anchor preceding the heading=]@@%0a%0aIf there is no identifier or anchor with a heading, then the anchor will be in the form @@%25blue%25#toc-1.2.1%25%25@@ where 1.2.1 is the structural path to the section, in this example "Section 1, subsection 2, sub-subsection 1".%0a%0a%0aThe following local configuration (in local/config.php) can control the default settings:%0a%0a* @@$PmTOC['Enable'] = 1; @@# enable TOC, default is disabled.%0a* @@$PmTOC['MaxLevel'] = 6;@@ # levels of headings that are included in the TOC, by default %3ch1> to %3ch6> headings are included. Set to 3 to only include %3ch1> to %3ch3> headings.%0a* @@$PmTOC['MinNumber'] = 3;@@ # minimum number of headings in the page for the TOC to be generated. Pages with few headings are usually short and do not need a TOC. %0a** @@$PmTOC['MinNumber'] = 2; @@# pages with 2+ headings will have a TOC%0a** @@$PmTOC['MinNumber'] = -1; @@# the TOC will not be automatic, only the [@(:toc:)@] directive will create a table of contents in the page.%0a* @@$PmTOC['NumberedHeadings'] = '1.1.1.1.1.1'; @@# the headings will be numbered (default disabled).%0a** You can set here the numerals for the different levels of headings, can be @@1@@ (numeric), @@I@@ or @@i@@ (Roman numerals), @@A@@ or @@a@@ (letters A-Z or a-z). For example, a specification like \\%0a   @@$PmTOC['NumberedHeadings'] = 'I.1.a'; @@ \\%0a   will number the biggest level headings on a page with uppercase Roman numerals (I, II, ...), the second biggest with numbers, the third with lowercase letters (a, b, ...), and the remaining levels (if any) with numbers.%0a* @@$PmTOC['EnableBacklinks'] = 1; @@# insert after the headings "↑" arrows linking back to the table of contents (default disabled).%0a* @@$PmTOC['ParentElement'] = "#wikitext"; @@# the query selector of the parent HTML element where the TOC block to be inserted; by default the TOC is inserted before the first heading; here you can select a different element. If selected, the TOC will be inserted in the element at the top. The [@(:toc:)@] directive in the page can override this element.%0a%0aThe following strings can be translated in XLPage, for example in French:%0a%0a  "Contents" => "Sommaire",%0a  "show"     => "afficher",%0a  "hide"     => "masquer",%0a%0aSee also: Cookbook:AutoTOC. If you previously used AutoTOC you need to disable it when enabling $PmTOC.%0a
+time=1574376074
 title=Table of contents