Skip to content

Allow default TOC container format to be overridden #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 7, 2024
Merged

Allow default TOC container format to be overridden #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions pelican/plugins/toc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,15 @@
toc
===================================
Generates Table of Contents for markdown.
Only generates a ToC for the headers FOLLOWING th [TOC] tag,
Only generates a ToC for the headers FOLLOWING the [TOC] tag,
so you can insert it after a specific section that need not be
include in the ToC.
included in the ToC.

The default container format (which includes a 'Table of Contents' heading )
can be overridden by providing something like the following entry in pelicanconf.py:
ASF_TOC = {
'CONTAINER_FORMAT': "<div id='toc'>{}</div>"
}
'''

from __future__ import unicode_literals
Expand Down Expand Up @@ -42,12 +48,13 @@ def unique(id_, ids):


class HtmlTreeNode(object):
def __init__(self, parent, header, level, id_):
def __init__(self, parent, header, level, id_, content):
self.children = []
self.parent = parent
self.header = header
self.level = level
self.id = id_
self.content = content

def add(self, new_header, ids):
new_level = new_header.name
Expand All @@ -66,11 +73,11 @@ def add(self, new_header, ids):
new_id = unique(new_id, ids) # make sure id is unique
new_header.attrs['id'] = new_id
if(self.level < new_level):
new_node = HtmlTreeNode(self, new_string, new_level, new_id)
new_node = HtmlTreeNode(self, new_string, new_level, new_id, self.content)
self.children += [new_node]
return new_node, new_header
elif(self.level == new_level):
new_node = HtmlTreeNode(self.parent, new_string, new_level, new_id)
new_node = HtmlTreeNode(self.parent, new_string, new_level, new_id, self.content)
self.parent.children += [new_node]
return new_node, new_header
elif(self.level > new_level):
Expand All @@ -90,7 +97,12 @@ def __str__(self):
ret = "<li>{}</li>".format(ret)

if not self.parent:
ret = "<div id='toc' style='border-radius: 3px; border: 1px solid #999; background-color: #EEE; padding: 4px;'><h4>Table of Contents:</h4><ul>{}</ul></div>".format(ret)
fmt = self.content.settings.get('ASF_TOC',{}).get('CONTAINER_FORMAT')
if fmt:
print(f"Overriding TOC CONTAINER_FORMAT: {fmt}")
else:
fmt = "<div id='toc' style='border-radius: 3px; border: 1px solid #999; background-color: #EEE; padding: 4px;'><h4>Table of Contents:</h4><ul>{}</ul></div>"
ret = fmt.format(ret)

return ret

Expand All @@ -114,7 +126,7 @@ def generate_toc(content):

all_ids = set()
title = content.metadata.get('title', 'Title')
tree = node = HtmlTreeNode(None, title, 'h0', '')
tree = node = HtmlTreeNode(None, title, 'h0', '', content)
soup = BeautifulSoup(content._content, 'html.parser') # pylint: disable=protected-access
settoc = False

Expand Down