665715 - Kuma: Show a table of contents on each page, showing H1-H3 headers

Status: RESOLVED FIXED

(developer.mozilla.org Graveyard :: Wiki pages, defect, P1)

Comment 1

[Luke Crouch [:groovecoder]]

Automatically-generated Table of Contents.

This needs the template system.

Comment 3

[Luke Crouch [:groovecoder]]

11:40:53 - sheppy: groovecoder: It's automatic. There's a preference to say how many levels deep to make the TOC, and we have it set to only go two deep.
11:41:09 - groovecoder: sheppy: okay
11:41:09 - sheppy: And it pulls them from the Hx blocks.

Comment 4

[Les Orchard [:lorchard]]

I'd suggest we try the HTML5 Outline algorithm to construct a ToC:

https://developer.mozilla.org/en/Sections_and_Outlines_of_an_HTML5_document#The_HTML5_Outline_Algorithm

http://dev.w3.org/html5/spec/headings-and-sections.html#outlines

We already use something like it, to identify the sections for section editing.

Comment 5

[Les Orchard [:lorchard]]

And, this doesn't necessarily need the templating system. But, it should build the ToC from the source resulting *after* macro evaluation so that any sections or headers introduced by templates are included

Comment 6

[Eric Shepherd [:sheppy]]

Ideally, there would be some way to tell the wiki not to generate a TOC on a particular page; for example, landing pages don't usually need one, since they're small, and the TOC clutters them up.

Comment 7

[Luke Crouch [:groovecoder]]

Checkbox for No TOC, generate TOC markup server-side w/ HTML5 outline algorithm.

Highest-level header might actually be H2 or something.

Comment 8

[[github robot]]

Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/96d1c26e977f1b2bc3d196f23081ef90f49b7e07
Merge pull request #154 from groovecoder/665715-toc

Bug 665715 generate TOC for document view

Comment 9

[raymond [:retornam] (inactive)]

qa-verified https://developer-stage9.mozilla.org/en/HTML/HTML5