{{ $ctx := .Context }}{{ with .Data }}{{ .Content }}{{ end }}
+{{ $ctx := .Context }}{{ with .Data }}{{ range $index, $element := .Elements }}{{ renderPlainString $ctx $element | printf "%s" }}{{ end }}{{ end }}
{{ $ctx := .Context }}{{ with .Data }}{{ .Content }}{{ end }}
+{{ $ctx := .Context }}{{ with .Data }}{{ range $index, $element := .Elements }}{{ renderPlainString $ctx $element | printf "%s" }}{{ end }}{{ end }}
-{{ renderElements $ctx .Elements }} +{{ renderElements $ctx .Elements | printf "%s" }}{{ if .Attribution.First }}
{{ renderElements $ctx .Elements }}{{ if .Attribution.First }}
+{{ $ctx := .Context }}{{ with .Data }}{{ renderElements $ctx .Elements | printf "%s" }}{{ if .Attribution.First }}
{{ $renderedLines }}
|
@@ -45,7 +45,7 @@ func init() {
})
listParagraphTmpl = newTextTemplate("list paragraph",
- `{{ $ctx := .Context }}{{ with .Data }} {{ renderLines $ctx .Lines }} {{ end }}`, + `{{ $ctx := .Context }}{{ with .Data }}{{ renderLines $ctx .Lines .HardBreak }} {{ end }}`, texttemplate.FuncMap{ "renderLines": renderLinesAsString, }) @@ -73,17 +73,19 @@ func renderParagraph(ctx *renderer.Context, p types.Paragraph) ([]byte, error) { err = admonitionParagraphTmpl.Execute(result, ContextualPipeline{ Context: ctx, Data: struct { - ID string - Class string - Icon string - Title string - Lines []types.InlineElements + ID string + Class string + Icon string + Title string + Lines []types.InlineElements + HardBreak bool }{ - ID: id, - Class: getClass(k), - Icon: getIcon(k), - Title: getTitle(p.Attributes[types.AttrTitle]), - Lines: p.Lines, + ID: id, + Class: getClass(k), + Icon: getIcon(k), + Title: getTitle(p.Attributes[types.AttrTitle]), + Lines: p.Lines, + HardBreak: false, }, }) } else if ctx.WithinDelimitedBlock() || ctx.WithinList() { @@ -91,13 +93,15 @@ func renderParagraph(ctx *renderer.Context, p types.Paragraph) ([]byte, error) { err = listParagraphTmpl.Execute(result, ContextualPipeline{ Context: ctx, Data: struct { - ID string - Title string - Lines []types.InlineElements + ID string + Title string + Lines []types.InlineElements + HardBreak bool }{ - ID: id, - Title: title, - Lines: p.Lines, + ID: id, + Title: title, + Lines: p.Lines, + HardBreak: false, }, }) } else { @@ -105,13 +109,15 @@ func renderParagraph(ctx *renderer.Context, p types.Paragraph) ([]byte, error) { err = paragraphTmpl.Execute(result, ContextualPipeline{ Context: ctx, Data: struct { - ID string - Title string - Lines []types.InlineElements + ID string + Title string + Lines []types.InlineElements + HardBreak bool }{ - ID: id, - Title: title, - Lines: p.Lines, + ID: id, + Title: title, + HardBreak: p.Attributes.Has(types.AttrHardBreaks), + Lines: p.Lines, }, }) } @@ -122,6 +128,10 @@ func renderParagraph(ctx *renderer.Context, p types.Paragraph) ([]byte, error) { return result.Bytes(), nil } +func renderLineBreak() ([]byte, error) { + return []byte(""), nil +} + func getClass(kind types.AdmonitionKind) string { switch kind { case types.Tip: diff --git a/pkg/renderer/html5/paragraph_test.go b/pkg/renderer/html5/paragraph_test.go index 169d180f..cfe872ad 100644 --- a/pkg/renderer/html5/paragraph_test.go +++ b/pkg/renderer/html5/paragraph_test.go @@ -1,6 +1,8 @@ package html5_test -import . "github.com/onsi/ginkgo" +import ( + . "github.com/onsi/ginkgo" +) var _ = Describe("paragraphs", func() { @@ -52,6 +54,35 @@ and here another paragraph ` verify(GinkgoT(), expectedResult, actualContent) }) + + Context("paragraphs with line break", func() { + + It("with explicit line break", func() { + actualContent := `foo + +bar +baz` + expectedResult := `
+ `
+ verify(GinkgoT(), expectedResult, actualContent)
+ })
+
+ It("with paragraph attribute", func() {
+
+ actualContent := `[%hardbreaks]
+foo
+bar
+baz`
+ expectedResult := `foo
+ `
+ verify(GinkgoT(), expectedResult, actualContent)
+ })
+ })
})
Context("admonition paragraphs", func() {
diff --git a/pkg/renderer/html5/renderer.go b/pkg/renderer/html5/renderer.go
index 299f82fc..69ed4248 100644
--- a/pkg/renderer/html5/renderer.go
+++ b/pkg/renderer/html5/renderer.go
@@ -18,14 +18,14 @@ func Render(ctx *renderer.Context, output io.Writer) (map[string]interface{}, er
type rendererFunc func(*renderer.Context, interface{}) ([]byte, error)
-func renderElements(ctx *renderer.Context, elements []interface{}, renderElementFunc rendererFunc) ([]byte, error) {
+func renderElements(ctx *renderer.Context, elements []interface{}) ([]byte, error) {
log.Debugf("rendered %d element(s)...", len(elements))
buff := bytes.NewBuffer(nil)
hasContent := false
for _, element := range elements {
- renderedElement, err := renderElementFunc(ctx, element)
+ renderedElement, err := renderElement(ctx, element)
if err != nil {
- return nil, errors.Wrapf(err, "unable to render paragraph element")
+ return nil, errors.Wrapf(err, "unable to render an element")
}
// insert new line if there's already some content
if hasContent && len(renderedElement) > 0 {
@@ -40,44 +40,6 @@ func renderElements(ctx *renderer.Context, elements []interface{}, renderElement
return buff.Bytes(), nil
}
-func renderElementsAsString(ctx *renderer.Context, elements []interface{}) (string, error) {
- result, err := renderElements(ctx, elements, renderElement)
- if err != nil {
- return "", err
- }
- return string(result), nil
-}
-
-func renderInlineElements(ctx *renderer.Context, elements []types.InlineElements, renderElementFunc rendererFunc) ([]byte, error) {
- log.Debugf("rendered %d element(s)...", len(elements))
- buff := bytes.NewBuffer(nil)
- hasContent := false
- for _, element := range elements {
- renderedElement, err := renderElementFunc(ctx, element)
- if err != nil {
- return nil, errors.Wrapf(err, "unable to render paragraph element")
- }
- // insert new line if there's already some content
- if hasContent && len(renderedElement) > 0 {
- buff.WriteString("\n")
- }
- buff.Write(renderedElement)
- if len(renderedElement) > 0 {
- hasContent = true
- }
- }
- // log.Debugf("rendered elements: '%s'", buff.String())
- return buff.Bytes(), nil
-}
-
-func renderInlineElementsAsString(ctx *renderer.Context, elements []types.InlineElements) (string, error) {
- result, err := renderInlineElements(ctx, elements, renderElement)
- if err != nil {
- return "", err
- }
- return string(result), nil
-}
-
func renderElement(ctx *renderer.Context, element interface{}) ([]byte, error) {
// log.Debugf("rendering element of type `%T`", element)
switch e := element.(type) {
@@ -116,7 +78,7 @@ func renderElement(ctx *renderer.Context, element interface{}) ([]byte, error) {
case types.InlineElements:
return renderLine(ctx, e, renderElement)
case []interface{}:
- return renderElements(ctx, e, renderElement)
+ return renderElements(ctx, e)
case types.InlineLink:
return renderLink(ctx, e)
case types.StringElement:
@@ -129,8 +91,8 @@ func renderElement(ctx *renderer.Context, element interface{}) ([]byte, error) {
case types.DocumentAttributeReset:
// 'process' function do not return any rendered content, but may return an error
return nil, processAttributeReset(ctx, e)
- // case types.DocumentAttributeSubstitution:
- // return renderAttributeSubstitution(ctx, e)
+ case types.LineBreak:
+ return renderLineBreak()
case types.SingleLineComment:
return nil, nil // nothing to do
default:
@@ -138,14 +100,6 @@ func renderElement(ctx *renderer.Context, element interface{}) ([]byte, error) {
}
}
-func renderElementAsString(ctx *renderer.Context, element interface{}) (string, error) {
- result, err := renderElement(ctx, element)
- if err != nil {
- return "", err
- }
- return string(result), nil
-}
-
func renderPlainString(ctx *renderer.Context, element interface{}) ([]byte, error) {
log.Debugf("rendering plain string for element of type %T", element)
switch element := element.(type) {
@@ -162,9 +116,7 @@ func renderPlainString(ctx *renderer.Context, element interface{}) ([]byte, erro
case types.StringElement:
return []byte(element.Content), nil
case types.Paragraph:
- return renderPlainString(ctx, element.Lines)
- case []types.InlineElements:
- return renderLines(ctx, element)
+ return renderLines(ctx, element.Lines, renderPlainString, false)
case types.InlineElements:
return renderLine(ctx, element, renderPlainString)
default:
@@ -172,25 +124,6 @@ func renderPlainString(ctx *renderer.Context, element interface{}) ([]byte, erro
}
}
-func discardTrailingBlankLines(elements []interface{}) []interface{} {
- // discard blank lines at the end
- filteredElements := make([]interface{}, len(elements))
- copy(filteredElements, elements)
- for {
- if len(filteredElements) == 0 {
- break
- }
- if _, ok := filteredElements[len(filteredElements)-1].(types.BlankLine); ok {
- log.Debugf("element of type %T at position %d is a blank line, discarding it", len(filteredElements)-1, filteredElements[len(filteredElements)-1])
- // remove last element of the slice since it's a blankline
- filteredElements = filteredElements[:len(filteredElements)-1]
- } else {
- break
- }
- }
- return filteredElements
-}
-
// includeNewline returns an "\n" sequence if the given index is NOT the last entry in the given description lines, empty string otherwise.
// also, it ignores the element if it is a blankline, depending on the context
func includeNewline(ctx renderer.Context, index int, content interface{}) string {
@@ -211,13 +144,3 @@ func includeNewline(ctx renderer.Context, index int, content interface{}) string
}
return ""
}
-
-// returns the attribute value for the given if it exists and is a string, empty string otherwise
-func attributeAsString(attrs map[string]interface{}, key string) string {
- if attr, ok := attrs[key]; ok {
- if attr, ok := attr.(string); ok {
- return attr
- }
- }
- return ""
-}
diff --git a/pkg/renderer/html5/section.go b/pkg/renderer/html5/section.go
index 9eebbd53..1de386a8 100644
--- a/pkg/renderer/html5/section.go
+++ b/pkg/renderer/html5/section.go
@@ -23,33 +23,45 @@ func init() {
preambleTmpl = newTextTemplate("preamble",
`foo
-{{.}}
+{{ $ctx := .Context }}{{ with .Data }}{{ renderElements $ctx .Elements | printf "%s" }}{{ end }}
-
+ `{{ $ctx := .Context }}{{ with .Data }}
{{.SectionTitle}}
- {{ end }}`,
+ texttemplate.FuncMap{
+ "renderElements": renderElements,
+ })
otherSectionContentTmpl = newTextTemplate("other section",
- `{{ if .Elements }}
-{{.Elements}}{{end}}
+ `)
+{{ $elements := renderElements $ctx .Elements | printf "%s" }}{{ if $elements }}
+{{ $elements }}{{ end }}
-
-{{.SectionTitle}}{{ if .Elements }}
-{{.Elements}}{{end}}
- `)
+ `{{ $ctx := .Context }}{{ with .Data }}
+{{ .SectionTitle }}{{ $elements := renderElements $ctx .Elements | printf "%s" }}{{ if $elements }}
+{{ $elements }}{{ end }}
+ {{ end }}`,
+ texttemplate.FuncMap{
+ "renderElements": renderElements,
+ })
sectionHeaderTmpl = newTextTemplate("other sectionTitle",
`{{ renderElement $ctx $cell }} | {{ includeNewline $ctx $index $headerCells }}{{ end }}
+{{ $headerCells := .Header.Cells }}{{ range $index, $cell := $headerCells }}{{ renderElement $ctx $cell | printf "%s" }} | {{ includeNewline $ctx $index $headerCells }}{{ end }}
| {{ includeNewline $ctx $indexCells $line.Cells }}{{ end }}
+{{ range $indexCells, $cell := $line.Cells }}{{ renderElement $ctx $cell }} | {{ includeNewline $ctx $indexCells $line.Cells }}{{ end }}
{{ renderElement $ctx $cell | printf "%s" }} |