Skip to content
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

Jump to bottom

Add TOC depth option #282

Merged
merged 1 commit into from Nov 16, 2017
Merged

Add TOC depth option #282

Show file tree
Hide file tree
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions lib/markdown2.py
View file
Open in desktop
Expand Up @@ -243,6 +243,10 @@ def __init__(self, html4tags=False, tab_width=4, safe_mode=None,
assert isinstance(self.extras, dict)
if "toc" in self.extras and "header-ids" not in self.extras:
self.extras["header-ids"] = None # "toc" implies "header-ids"
if self.extras["toc"] is None:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What exactly is if self.extras["toc"] is None checking for? Some testing on my own and it doesn't seem to catch if extras = {'toc': {}} or if extras=['toc']. This might need to be more robust. Maybe something like (pseudo):

default_toc_depth = 6

try:
    self._toc_depth = self.extras["toc"].get("depth", default_toc_depth)
except TypeError:
    self._toc_depth = default_toc_depth

What's the default depth in master branch right now? Is 6 an appropriate default?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe both cases you mention are actually are covered:

  • extras=['toc'] -> at this point in the code, self.extras has been coerced to a dictionary (there's even an assert on line 243)
  • extras={'toc': {}} -> this will be caught by the call to .get(), which returns 6 if the dictionary doesn't contain the key depth.

The check is for the case where the user supplied a list, in which case it will be converted by code above (lines 238/241) to a dict with all values set to None, or simply if the user passed extras={'toc': None}. I can still add exception-catching if you'd like, but I don't think it's necessary unless the user is passing strange values in the extras dict.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, good look, you're right. I made an assumption that it was still a possible list at that point. No change necessary there.

In regards to the default depth, where did 6 come from? In master is the depth just 1?

Copy link
Contributor Author

@MattX MattX Nov 15, 2017 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I've taken the convention that depth = maximum header level that will be included in the TOC. I believe 6 is the maximum header level, so setting the depth to 6 (or more) will just include all headers in the TOC.

self._toc_depth = 6
else:
self._toc_depth = self.extras["toc"].get("depth", 6)
self._instance_extras = self.extras.copy()

self.link_patterns = link_patterns
Expand Down Expand Up @@ -1500,6 +1504,8 @@ def header_id_from_text(self, text, prefix, n):

_toc = None
def _toc_add_entry(self, level, id, name):
if level > self._toc_depth:
return
if self._toc is None:
self._toc = []
self._toc.append((level, id, self._unescape_special_chars(name)))
Expand Down
19 changes: 19 additions & 0 deletions test/tm-cases/toc_depth.html
View file
Open in desktop
@@ -0,0 +1,19 @@
<h1 id="readme-for-blah">README for Blah</h1>

<h2 id="introduction">Introduction</h2>

<h2 id="the-meat">The Meat</h2>

<h3 id="beef">Beef</h3>

<h5 id="steak">Steak</h5>

<h5 id="burgers">Burgers</h5>

<h3 id="chicken">Chicken</h3>

<h3 id="pork">Pork</h3>

<h4 id="mmmmmmmm-bacon">Mmmmmmmm, bacon</h4>

<h1 id="at-the-top-level-again">At the <em>top</em> level again!?</h1>
5 changes: 5 additions & 0 deletions test/tm-cases/toc_depth.opts
View file
Open in desktop
@@ -0,0 +1,5 @@
{
"extras": {
"toc": {"depth": 3}
}
}
1 change: 1 addition & 0 deletions test/tm-cases/toc_depth.tags
View file
Open in desktop
@@ -0,0 +1 @@
toc extra
20 changes: 20 additions & 0 deletions test/tm-cases/toc_depth.text
View file
Open in desktop
@@ -0,0 +1,20 @@
# README for Blah

## Introduction

## The Meat

### Beef

##### Steak

##### Burgers

### Chicken

### Pork

#### Mmmmmmmm, bacon

# At the *top* level again!?

13 changes: 13 additions & 0 deletions test/tm-cases/toc_depth.toc_html
View file
Open in desktop
@@ -0,0 +1,13 @@
<ul>
<li><a href="#readme-for-blah">README for Blah</a>
<ul>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#the-meat">The Meat</a>
<ul>
<li><a href="#beef">Beef</a></li>
<li><a href="#chicken">Chicken</a></li>
<li><a href="#pork">Pork</a></li>
</ul></li>
</ul></li>
<li><a href="#at-the-top-level-again">At the <em>top</em> level again!?</a></li>
</ul>