fix(renderer): do not always render preamble withing wrapper (#299)

depends if the document has a section level 0 (ie, a title)

fixes #298

Signed-off-by: Xavier Coulon <[email protected]>

.gitignore

@@ -61,3 +61,4 @@ coverage.txt
 *.html
 *.test
 !test/**/*.html
+*libasciidoc.html

pkg/renderer/html5/section.go

@@ -21,11 +21,11 @@ var otherSectionContentTmpl texttemplate.Template
 // initializes the templates
 func init() {
 	preambleTmpl = newTextTemplate("preamble",
-		`<div id="preamble">
+		`{{ $ctx := .Context }}{{ with .Data }}{{ if .Wrapper }}<div id="preamble">
 <div class="sectionbody">
-{{ $ctx := .Context }}{{ with .Data }}{{ renderElements $ctx .Elements | printf "%s" }}{{ end }}
+{{ end }}{{ renderElements $ctx .Elements | printf "%s" }}{{ if .Wrapper }}
 </div>
-</div>`,
+</div>{{ end }}{{ end }}`,
 		texttemplate.FuncMap{
 			"renderElements": renderElements,
 		})
@@ -54,11 +54,19 @@ func init() {
 func renderPreamble(ctx *renderer.Context, p types.Preamble) ([]byte, error) {
 	log.Debugf("Rendering preamble...")
 	result := bytes.NewBuffer(nil)
+	// the <div id="preamble"> wrapper is only necessary
+	// if the document has a section 0
+	wrapper := false
+	if ctx.Document.Attributes.HasTitle() {
+		wrapper = true
+	}
 	err := preambleTmpl.Execute(result, ContextualPipeline{
 		Context: ctx,
 		Data: struct {
+			Wrapper  bool
 			Elements []interface{}
 		}{
+			Wrapper:  wrapper,
 			Elements: p.Elements,
 		},
 	})

pkg/renderer/html5/section_test.go

@@ -228,6 +228,59 @@ Listing block content is commonly used to preserve code input.</pre>
 </div>`
 			verify(GinkgoT(), expectedResult, actualContent)
 		})
+	})
+
+	Context("preambles", func() {
+
+		It("should include preamble wrapper", func() {
+			actualContent := `= Title
+
+preamble 
+here
+
+== section 1
+
+content here`
+			expectedResult := `<div id="preamble">
+<div class="sectionbody">
+<div class="paragraph">
+<p>preamble
+here</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_section_1">section 1</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>content here</p>
+</div>
+</div>
+</div>`
+			verify(GinkgoT(), expectedResult, actualContent)
+		})
+
+		It("should not include preamble wrapper", func() {
+			actualContent := `preamble 
+here
 
+== section 1
+
+content here
+`
+			expectedResult := `<div class="paragraph">
+<p>preamble
+here</p>
+</div>
+<div class="sect1">
+<h2 id="_section_1">section 1</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>content here</p>
+</div>
+</div>
+</div>`
+			verify(GinkgoT(), expectedResult, actualContent)
+		})
 	})
 })

pkg/types/document_attributes.go

@@ -48,6 +48,12 @@ func (a DocumentAttributes) HasAuthors() bool {
 	return exists
 }
 
+// HasTitle returns `true` if the document has a title, ie, a section with level = 0
+func (a DocumentAttributes) HasTitle() bool {
+	_, found := a[title]
+	return found
+}
+
 // GetTitle retrieves the document title in its metadata, or returns nil if the title was not specified
 func (a DocumentAttributes) GetTitle() (SectionTitle, error) {
 	if t, found := a[title]; found {