{{ $ctx := .Context }}{{ with .Data }}{{ .Element }}{{ end }}{{ $ctx := .Context }}{{ with .Data }}{{ .Content }}{{ end }}
{{ $ctx := .Context }}{{ with .Data }}{{ $elements := .Elements }}{{ range $index, $element := $elements }}{{ renderElement $ctx $element | printf "%s" }}{{ if includeNewline $ctx $index $elements }}{{ print "\n" }}{{ end }}{{ end }}{{ end }}
@@ -35,6 +38,21 @@ func init() {
"renderElement": renderElement,
"includeNewline": includeNewline,
})
+
+ quoteBlockTmpl = newTextTemplate("quote block", `
+{{ $ctx := .Context }}{{ with .Data }}
`,
+ texttemplate.FuncMap{
+ "renderElement": renderElement,
+ "includeNewline": includeNewline,
+ })
+
verseBlockTmpl = newTextTemplate("verse block", `{{ $elements := .Elements }}{{ range $index, $element := $elements }} +{{ renderElement $ctx $element | printf "%s" }}{{ end }} +{{ if .Attribution.First }} +
+— {{ .Attribution.First }}{{ if .Attribution.Second }}
+{{ .Attribution.Second }}{{ end }} +
{{ end }}{{ end }}
++{{ .Attribution.Second }}{{ end }} +
{{ $ctx := .Context }}{{ with .Data }}
{{ $elements := .Elements }}{{ range $index, $element := $elements }}{{ renderElement $ctx $element | printf "%s" }}{{ if includeNewline $ctx $index $elements }}{{ print "\n" }}{{ end }}{{ end }}{{ if .Attribution.First }}
@@ -46,13 +64,15 @@ func init() {
"renderElement": renderElement,
"includeNewline": includeNewline,
})
- admonitionBlockTmpl = newTextTemplate("admonition block", `{{ $ctx := .Context }}{{ with .Data }}
+
+ admonitionBlockTmpl = newTextTemplate("admonition block", `{{ $ctx := .Context }}{{ with .Data }}
|
{{ .Icon }}
|
-+ | {{ if .Title }}
+ {{ .Title }} {{ end}}
{{ $elements := .Elements }}{{ range $index, $element := $elements }}{{ renderElement $ctx $element | printf "%s" }}{{ if includeNewline $ctx $index $elements }}{{ print "\n" }}{{ end }}{{ end }}
|
|
@@ -147,11 +148,12 @@ this is an admonition paragraph.
Note
|
+ Title2
This is an admonition block
-
with another paragraph +with another paragraph |
- 
| @@ -36,27 +36,20 @@ func init() { | {{ if .Title }}
{{ .Title }} {{ end }}
-{{ $renderedElements }}
+{{ $renderedLines }}
|
{{ $lines := .Lines }}{{ range $index, $line := $lines }}{{ renderElement $ctx $line | printf "%s" }}{{ if includeNewline $ctx $index $lines }}{{ print "\n" }}{{ end }}{{ end }}
{{ end }}`, texttemplate.FuncMap{ - "renderElement": renderElement, + "renderElement": renderElement, // TODO: use `renderLines` func as above "includeNewline": includeNewline, }) } @@ -71,7 +64,7 @@ func renderParagraph(ctx *renderer.Context, p types.Paragraph) ([]byte, error) { id = i } if t, ok := p.Attributes[types.AttrTitle].(string); ok { - title = t + title = strings.TrimSpace(t) } var err error if _, ok := p.Attributes[types.AttrAdmonitionKind]; ok { diff --git a/pkg/renderer/html5/paragraph_test.go b/pkg/renderer/html5/paragraph_test.go index 3931047e..082d9a50 100644 --- a/pkg/renderer/html5/paragraph_test.go +++ b/pkg/renderer/html5/paragraph_test.go @@ -8,10 +8,10 @@ var _ = Describe("paragraphs", func() { It("a standalone paragraph with special character", func() { actualContent := `*bold content* -& more content afterwards...` +& more content afterwards` expectedResult := `
-
`
verify(GinkgoT(), expectedResult, actualContent)
})
diff --git a/pkg/renderer/html5/passthrough.go b/pkg/renderer/html5/passthrough.go
index 5da38849..c85007ae 100644
--- a/pkg/renderer/html5/passthrough.go
+++ b/pkg/renderer/html5/passthrough.go
@@ -10,6 +10,7 @@ import (
)
func renderPassthrough(ctx *renderer.Context, p types.Passthrough) ([]byte, error) {
+ // ctx.SetTrimTrailingSpaces(false) // unless overridden by another element afterwards
renderedContent, err := renderPassthroughContent(ctx, p)
if err != nil {
return nil, errors.Wrap(err, "unable to render passthrough")
diff --git a/pkg/renderer/html5/passthrough_test.go b/pkg/renderer/html5/passthrough_test.go
index 6f237fa9..bf16b0d1 100644
--- a/pkg/renderer/html5/passthrough_test.go
+++ b/pkg/renderer/html5/passthrough_test.go
@@ -122,10 +122,18 @@ world
verify(GinkgoT(), expectedResult, actualContent)
})
- It("passthrough macro with quoted word in sentence", func() {
- actualContent := `pass:q[ a *hello*, world ]`
+ It("passthrough macro with quoted word in sentence and trailing spaces", func() {
+ actualContent := `pass:q[ a *hello*, world ] `
expectedResult := `bold content -& more content afterwards...
+bold content +& more content afterwards
a hello, world
+
+
`
verify(GinkgoT(), expectedResult, actualContent)
})
diff --git a/pkg/renderer/html5/quoted_text_test.go b/pkg/renderer/html5/quoted_text_test.go
index 63295a12..5a8a6de4 100644
--- a/pkg/renderer/html5/quoted_text_test.go
+++ b/pkg/renderer/html5/quoted_text_test.go
@@ -8,16 +8,16 @@ var _ = Describe("quoted texts", func() {
It("bold content alone", func() {
actualContent := "*bold content*"
expectedResult := `an hello, world mention
-
`
+bold content
-bold content
+
-
`
+some bold content.
-some bold content.
+
-
`
+some *bold and italic content * together.
-some *bold and italic content * together.
+` verify(GinkgoT(), expectedResult, actualContent) }) diff --git a/pkg/renderer/html5/renderer.go b/pkg/renderer/html5/renderer.go index 9986b598..cc8756a9 100644 --- a/pkg/renderer/html5/renderer.go +++ b/pkg/renderer/html5/renderer.go @@ -1,7 +1,6 @@ package html5 import ( - "bytes" "io" "reflect" @@ -20,7 +19,7 @@ func renderElement(ctx *renderer.Context, element interface{}) ([]byte, error) { log.Debugf("rendering element of type `%T`", element) switch e := element.(type) { case types.TableOfContentsMacro: - return renderTableOfContent(ctx, e) + return renderTableOfContents(ctx, e) case types.Section: return renderSection(ctx, e) case types.Preamble: @@ -50,7 +49,7 @@ func renderElement(ctx *renderer.Context, element interface{}) ([]byte, error) { case types.LiteralBlock: return renderLiteralBlock(ctx, e) case types.InlineElements: - return renderInlineElements(ctx, e) + return renderInlineElements(ctx, e, renderElement) case types.Link: return renderLink(ctx, e) case types.StringElement: @@ -74,9 +73,9 @@ func renderPlainString(ctx *renderer.Context, element interface{}) ([]byte, erro log.Debugf("rendering plain string for element of type %T", element) switch element := element.(type) { case types.SectionTitle: - return renderPlainStringForInlineElements(ctx, element.Content) + return renderPlainString(ctx, element.Content) case types.QuotedText: - return renderPlainStringForInlineElements(ctx, element.Elements) + return renderPlainString(ctx, element.Elements) case types.InlineImage: return []byte(element.Macro.Alt()), nil case types.Link: @@ -87,43 +86,28 @@ func renderPlainString(ctx *renderer.Context, element interface{}) ([]byte, erro return []byte(element.Content), nil case types.Paragraph: return renderPlainString(ctx, element.Lines) - case types.InlineElements: - buff := bytes.NewBuffer(nil) - for _, e := range element { - plainStringElement, err := renderPlainString(ctx, e) - if err != nil { - return nil, errors.Wrapf(err, "unable to render plain string for element of type %T", e) - } - buff.Write(plainStringElement) - } - return buff.Bytes(), nil case []types.InlineElements: - buff := bytes.NewBuffer(nil) - for _, e := range element { - plainStringElement, err := renderPlainString(ctx, e) - if err != nil { - return nil, errors.Wrapf(err, "unable to render plain string for element of type %T", e) - } - buff.Write(plainStringElement) - } - return buff.Bytes(), nil + return renderLines(ctx, element) + case types.InlineElements: + return renderInlineElements(ctx, element, renderPlainString) + case []interface{}: + return renderInlineElements(ctx, element, renderPlainString) default: - return nil, errors.Errorf("unexpectedResult type of element to process: %T", element) + return nil, errors.Errorf("unable to render plain string for element of type '%T'", element) } } -func renderPlainStringForInlineElements(ctx *renderer.Context, elements []interface{}) ([]byte, error) { - buff := bytes.NewBuffer(nil) - // for _, e := range discardTrailingBlankLinesInInlineElements(elements) { - for _, e := range elements { - plainStringElement, err := renderPlainString(ctx, e) - if err != nil { - return nil, errors.Wrap(err, "unable to render plain string value") - } - buff.Write(plainStringElement) - } - return buff.Bytes(), nil -} +// func renderPlainStringForElements(ctx *renderer.Context, elements []interface{}) ([]byte, error) { +// buff := bytes.NewBuffer(nil) +// for _, e := range elements { +// plainStringElement, err := renderPlainString(ctx, e) +// if err != nil { +// return nil, errors.Wrap(err, "unable to render plain string value") +// } +// buff.Write(plainStringElement) +// } +// return buff.Bytes(), nil +// } func discardTrailingBlankLines(elements []interface{}) []interface{} { // discard blank lines at the end @@ -174,3 +158,13 @@ func getID(attributes map[string]interface{}) string { } return id } + +// 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/renderer_test.go b/pkg/renderer/html5/renderer_test.go index 83212400..5f6aacd0 100644 --- a/pkg/renderer/html5/renderer_test.go +++ b/pkg/renderer/html5/renderer_test.go @@ -32,7 +32,7 @@ func verify(t GinkgoTInterface, expectedResult, content string, rendererOpts ... } t.Log("* Done processing document:") result := buff.String() - expectedResult = strings.Replace(expectedResult, "\t", "", -1) + // expectedResult = strings.Replace(expectedResult, "\t", "", -1) t.Logf("** Actual output:\n`%s`\n", result) t.Logf("** expectedResult output:\n`%s`\n", expectedResult) // remove tabs that can be inserted by VSCode while formatting the tests code dmp := diffmatchpatch.New() diff --git a/pkg/renderer/html5/string.go b/pkg/renderer/html5/string.go index bc3a085c..1fc5cf99 100644 --- a/pkg/renderer/html5/string.go +++ b/pkg/renderer/html5/string.go @@ -17,7 +17,9 @@ func init() { } func renderStringElement(ctx *renderer.Context, str types.StringElement) ([]byte, error) { + // ctx.SetTrimTrailingSpaces(true) // trailing spaces can be trimmed if the last element of a line is a StringElement result := bytes.NewBuffer(nil) + // content := strings.Replace(str.Content, "\t", " ", -1) err := stringElementTmpl.Execute(result, str.Content) if err != nil { return nil, errors.Wrapf(err, "unable to render string element") diff --git a/pkg/renderer/html5/table_of_contents.go b/pkg/renderer/html5/table_of_contents.go index c84893a8..5be4ee03 100644 --- a/pkg/renderer/html5/table_of_contents.go +++ b/pkg/renderer/html5/table_of_contents.go @@ -26,27 +26,32 @@ func init() { {{end}}`) } -type TableOfContent struct { +// TableOfContents the structure of the table of contents +type TableOfContents struct { Content template.HTML } -type TableOfContentSectionGroup struct { + +// TableOfContentsSectionGroup a group of sections in the table of contents +type TableOfContentsSectionGroup struct { Level int - Elements []TableOfContentSection + Elements []TableOfContentsSection } -type TableOfContentSection struct { + +// TableOfContentsSection a section in the table of contents +type TableOfContentsSection struct { Level int Href string Title template.HTML Subelements *template.HTML } -func renderTableOfContent(ctx *renderer.Context, m types.TableOfContentsMacro) ([]byte, error) { +func renderTableOfContents(ctx *renderer.Context, m types.TableOfContentsMacro) ([]byte, error) { result := bytes.NewBuffer(nil) - renderedSections, err := renderTableOfContentSections(ctx, ctx.Document.Elements, 1) + renderedSections, err := renderTableOfContentsSections(ctx, ctx.Document.Elements, 1) if err != nil { return nil, errors.Wrapf(err, "error while rendering table of content") } - err = tableOfContentTmpl.Execute(result, TableOfContent{ + err = tableOfContentTmpl.Execute(result, TableOfContents{ Content: *renderedSections, }) if err != nil { @@ -56,8 +61,8 @@ func renderTableOfContent(ctx *renderer.Context, m types.TableOfContentsMacro) ( return result.Bytes(), nil } -func renderTableOfContentSections(ctx *renderer.Context, elements []interface{}, currentLevel int) (*template.HTML, error) { - sections := make([]TableOfContentSection, 0) +func renderTableOfContentsSections(ctx *renderer.Context, elements []interface{}, currentLevel int) (*template.HTML, error) { + sections := make([]TableOfContentsSection, 0) for _, element := range elements { log.Debugf("traversing document element of type %T", element) switch section := element.(type) { @@ -72,7 +77,7 @@ func renderTableOfContentSections(ctx *renderer.Context, elements []interface{}, } var renderedChildSections *template.HTML if currentLevel < *tocLevels { - renderedChildSections, err = renderTableOfContentSections(ctx, section.Elements, currentLevel+1) + renderedChildSections, err = renderTableOfContentsSections(ctx, section.Elements, currentLevel+1) if err != nil { return nil, errors.Wrapf(err, "error while rendering table of content section") } @@ -82,7 +87,7 @@ func renderTableOfContentSections(ctx *renderer.Context, elements []interface{}, id = i } renderedTitleStr := strings.TrimSpace(string(renderedTitle)) - sections = append(sections, TableOfContentSection{ + sections = append(sections, TableOfContentsSection{ Level: section.Level, Href: id, Title: template.HTML(renderedTitleStr), @@ -94,7 +99,7 @@ func renderTableOfContentSections(ctx *renderer.Context, elements []interface{}, return nil, nil } resultBuf := bytes.NewBuffer(nil) - tableOfContentSectionSetTmpl.Execute(resultBuf, TableOfContentSectionGroup{ + tableOfContentSectionSetTmpl.Execute(resultBuf, TableOfContentsSectionGroup{ Level: sections[0].Level, Elements: sections, }) diff --git a/pkg/renderer/html5/unordered_list_test.go b/pkg/renderer/html5/unordered_list_test.go index 20a3e211..87f5e5a9 100644 --- a/pkg/renderer/html5/unordered_list_test.go +++ b/pkg/renderer/html5/unordered_list_test.go @@ -141,12 +141,12 @@ another delimited blockfoo
-
a delimited blocka delimited block
-
another delimited blockanother delimited block
-
a delimited blocka delimited block
@@ -188,7 +188,7 @@ another delimited block
-
another delimited blockanother delimited block