voussoir/epubfile
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve comments in generate_toc.

Browse source
This commit is contained in:
Ethan Dalool 2020-02-03 23:12:36 -08:00
parent 81fe7cd47b
commit 38f432fe6e
1 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
epubfile.py
View file

@ -1024,6 +1024,10 @@ class Epub:
if not nav_id and not ncx_id:
return
# Note: The toc generated by the upcoming loop is in a sort of agnostic
# format, since it needs to be converted into nav.html and toc.ncx which
# have different structural requirements. The attributes that I'm using
# in this initial toc object DO NOT represent any part of the epub format.
toc = new_list(root=True)
current_level = None
current_list = toc.ol
@ -1061,10 +1065,15 @@ class Epub:
current_list = current_list.parent
if current_list.name == 'li':
current_list = current_list.parent
# If the file has headers in a non-ascending order, like an
# h4 and then an h1, then backstepping too far will take us
# out of the list. So at that point we can just snap
# current_level and start using the root list again.
# If the file has headers in a non-ascending order, like the
# first header is an h4 and then an h1 comes later, then
# this while loop would keep attempting to climb the .parent
# which would take us too far, off the top of the tree.
# So, if we reach `current_list == toc.ol` then we've
# reached the root and should stop climbing. At that point
# we can just snap current_level and use the root list again.
# In the resulting toc, that initial h4 would have the same
# toc depth as the later h1 since it never had parents.
if current_list == toc:
current_level = level
current_list = toc.ol
@ -1073,12 +1082,13 @@ class Epub:
current_level = level
# In order to properly render nested <ol>, you're supposed
# to make the new <ol> a child of the last <li> of the
# previous <ol>.
# previous <ol>. NOT a child of the prev <ol> directly.
# Don't worry, .children can never be empty because on the
# first <li> this condition can never occur, and new <ol>s
# always receive a child right after being created.
_l = new_list()
list(current_list.children)[-1].append(_l)
final_li = list(current_list.children)[-1]
final_li.append(_l)
current_list = _l
current_list.append(toc_line)