phoenix/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-07-07 09:36:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

markup/tableofcontents: GoDoc etc.

Browse source
This commit is contained in:
Bjørn Erik Pedersen 2019-11-23 16:59:43 +01:00
parent 20f351ee4c
commit 55f951cbba
No known key found for this signature in database
GPG key ID: 330E6E2BD4859D8F
1 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
markup/tableofcontents/tableofcontents.go
View file

@ -17,8 +17,10 @@ import (
"strings" "strings"
) )
// Headers holds the top level (h1) headers.
type Headers []Header type Headers []Header
// Header holds the data about a header and its children.
type Header struct { type Header struct {
ID string ID string
Text string Text string
@ -26,14 +28,18 @@ type Header struct {
Headers Headers Headers Headers
} }
// IsZero is true when no ID or Text is set.
func (h Header) IsZero() bool { func (h Header) IsZero() bool {
return h.ID == "" && h.Text == "" return h.ID == "" && h.Text == ""
} }
// Root implements AddAt, which can be used to build the
// data structure for the ToC.
type Root struct { type Root struct {
Headers Headers Headers Headers
} }
// AddAt adds the header into the given location.
func (toc *Root) AddAt(h Header, y, x int) { func (toc *Root) AddAt(h Header, y, x int) {
for i := len(toc.Headers); i <= y; i++ { for i := len(toc.Headers); i <= y; i++ {
toc.Headers = append(toc.Headers, Header{}) toc.Headers = append(toc.Headers, Header{})
@ -55,6 +61,7 @@ func (toc *Root) AddAt(h Header, y, x int) {
header.Headers = append(header.Headers, h) header.Headers = append(header.Headers, h)
} }
// ToHTML renders the ToC as HTML.
func (toc Root) ToHTML(startLevel, stopLevel int) string { func (toc Root) ToHTML(startLevel, stopLevel int) string {
b := &tocBuilder{ b := &tocBuilder{
s: strings.Builder{}, s: strings.Builder{},
@ -75,19 +82,19 @@ type tocBuilder struct {
} }
func (b *tocBuilder) Build() { func (b *tocBuilder) Build() {
b.buildHeaders2(b.h) b.writeNav(b.h)
} }
func (b *tocBuilder) buildHeaders2(h Headers) { func (b *tocBuilder) writeNav(h Headers) {
b.s.WriteString("<nav id=\"TableOfContents\">") b.s.WriteString("<nav id=\"TableOfContents\">")
b.buildHeaders(1, 0, b.h) b.writeHeaders(1, 0, b.h)
b.s.WriteString("</nav>") b.s.WriteString("</nav>")
} }
func (b *tocBuilder) buildHeaders(level, indent int, h Headers) { func (b *tocBuilder) writeHeaders(level, indent int, h Headers) {
if level < b.startLevel { if level < b.startLevel {
for _, h := range h { for _, h := range h {
b.buildHeaders(level+1, indent, h.Headers) b.writeHeaders(level+1, indent, h.Headers)
} }
return return
} }
@ -105,7 +112,7 @@ func (b *tocBuilder) buildHeaders(level, indent int, h Headers) {
} }
for _, h := range h { for _, h := range h {
b.buildHeader(level+1, indent+2, h) b.writeHeader(level+1, indent+2, h)
} }
if hasChildren { if hasChildren {
@ -116,13 +123,13 @@ func (b *tocBuilder) buildHeaders(level, indent int, h Headers) {
} }
} }
func (b *tocBuilder) buildHeader(level, indent int, h Header) { func (b *tocBuilder) writeHeader(level, indent int, h Header) {
b.indent(indent) b.indent(indent)
b.s.WriteString("<li>") b.s.WriteString("<li>")
if !h.IsZero() { if !h.IsZero() {
b.s.WriteString("<a href=\"#" + h.ID + "\">" + h.Text + "</a>") b.s.WriteString("<a href=\"#" + h.ID + "\">" + h.Text + "</a>")
} }
b.buildHeaders(level, indent, h.Headers) b.writeHeaders(level, indent, h.Headers)
b.s.WriteString("</li>\n") b.s.WriteString("</li>\n")
} }
@ -132,6 +139,7 @@ func (b *tocBuilder) indent(n int) {
} }
} }
// DefaultConfig is the default ToC configuration.
var DefaultConfig = Config{ var DefaultConfig = Config{
StartLevel: 2, StartLevel: 2,
EndLevel: 3, EndLevel: 3,