You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "michael-o (via GitHub)" <gi...@apache.org> on 2023/01/29 18:55:21 UTC
[GitHub] [maven-doxia] michael-o commented on a diff in pull request #141: [DOXIA-690] Improved support of metadata (both YAML front matter and
michael-o commented on code in PR #141:
URL: https://github.com/apache/maven-doxia/pull/141#discussion_r1090033038
##########
doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java:
##########
@@ -76,19 +83,23 @@ public class MarkdownParser extends AbstractTextParser implements TextMarkup {
* In order to ensure that we have minimal risk of false positives when slurping metadata sections, the
* first key in the metadata section must be one of these standard keys or else the entire metadata section is
* ignored.
+ * @see <a href="https://fletcher.github.io/MultiMarkdown-5/metadata.html">Multimarkdown Metadata</a>
Review Comment:
Is this really correct? MultiMarkdown vs CommonMark?
##########
doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java:
##########
@@ -156,6 +178,86 @@ public void parse(Reader source, Sink sink, String reference) throws ParseExcept
}
}
+ private boolean processMetadataForHtml(StringBuilder html, StringBuilder source) {
+ final Map<String, List<String>> metaData;
Review Comment:
metadata
##########
doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java:
##########
@@ -156,6 +178,86 @@ public void parse(Reader source, Sink sink, String reference) throws ParseExcept
}
}
+ private boolean processMetadataForHtml(StringBuilder html, StringBuilder source) {
+ final Map<String, List<String>> metaData;
+ final int endOffset; // end of metadata within source
+ // support two types of metadata:
+ if (source.toString().startsWith("---")) {
+ // 1. YAML front matter (https://github.com/vsch/flexmark-java/wiki/Extensions#yaml-front-matter)
+ Node documentRoot = FLEXMARK_METADATA_PARSER.parse(source.toString());
+ YamlFrontMatterVisitor visitor = new YamlFrontMatterVisitor();
+ visitor.visit(documentRoot);
+ metaData = visitor.getData();
+ endOffset = visitor.getEndOffset();
+ } else {
+ // 2. Multimarkdown metadata (https://fletcher.github.io/MultiMarkdown-5/metadata.html), not yet supported
+ // by Flexmark (https://github.com/vsch/flexmark-java/issues/550)
+ metaData = new LinkedHashMap<>();
+ Matcher metadataMatcher = METADATA_SECTION_PATTERN.matcher(source);
+ if (metadataMatcher.find()) {
+ String entry = metadataMatcher.group(0) + '\n';
+ Matcher entryMatcher = METADATA_ENTRY_PATTERN.matcher(entry);
+ while (entryMatcher.find()) {
+ String key = entryMatcher.group(1);
+ String value = normalizeMultilineValue(entryMatcher.group(2));
+ metaData.put(key, Collections.singletonList(value));
+ }
+ endOffset = metadataMatcher.end(0);
+ } else {
+ endOffset = 0;
+ }
+ }
+ if (endOffset > 0) {
+ // Trim the metadata from the source
+ source.delete(0, endOffset);
+ }
+ return writeHtmlMetadata(html, metaData);
+ }
+
+ static String normalizeMultilineValue(String value) {
+ return value.trim().replaceAll("[ \\t]*[\\r\\n]+[ \\t]*", " ");
+ }
+
+ private boolean writeHtmlMetadata(StringBuilder html, Map<String, List<String>> data) {
+ boolean containsTitle = false;
+ for (Entry<String, List<String>> entry : data.entrySet()) {
+ if (writeHtmlMetadata(html, entry.getKey(), entry.getValue())) {
+ containsTitle = true;
+ }
+ }
+ return containsTitle;
+ }
+
+ private boolean writeHtmlMetadata(StringBuilder html, String key, List<String> values) {
+ if ("title".equalsIgnoreCase(key)) {
+ html.append("<title>");
+ html.append(HtmlTools.escapeHTML(values.stream().collect(Collectors.joining(", ")), false));
+ html.append("</title>");
+ return true;
+ } else {
+ if (key.equalsIgnoreCase("author") && values.size() > 1) {
+ // for multiple authors emit multiple meta tags
+ for (String value : values) {
+ writeHtmlMetadata(html, key, Collections.singletonList(value));
+ }
+ } else {
+ // every other multivalue should just be concatenated and emitted in a single meta tag
+ final String separator;
+ if (key.equalsIgnoreCase("keywords")) {
+ separator = ",";
+ } else {
+ separator = "\n";
Review Comment:
LS?
##########
doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java:
##########
@@ -156,6 +178,86 @@ public void parse(Reader source, Sink sink, String reference) throws ParseExcept
}
}
+ private boolean processMetadataForHtml(StringBuilder html, StringBuilder source) {
+ final Map<String, List<String>> metaData;
+ final int endOffset; // end of metadata within source
+ // support two types of metadata:
+ if (source.toString().startsWith("---")) {
+ // 1. YAML front matter (https://github.com/vsch/flexmark-java/wiki/Extensions#yaml-front-matter)
+ Node documentRoot = FLEXMARK_METADATA_PARSER.parse(source.toString());
+ YamlFrontMatterVisitor visitor = new YamlFrontMatterVisitor();
+ visitor.visit(documentRoot);
+ metaData = visitor.getData();
+ endOffset = visitor.getEndOffset();
+ } else {
+ // 2. Multimarkdown metadata (https://fletcher.github.io/MultiMarkdown-5/metadata.html), not yet supported
+ // by Flexmark (https://github.com/vsch/flexmark-java/issues/550)
+ metaData = new LinkedHashMap<>();
+ Matcher metadataMatcher = METADATA_SECTION_PATTERN.matcher(source);
+ if (metadataMatcher.find()) {
+ String entry = metadataMatcher.group(0) + '\n';
Review Comment:
LS?
##########
doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java:
##########
@@ -156,6 +178,86 @@ public void parse(Reader source, Sink sink, String reference) throws ParseExcept
}
}
+ private boolean processMetadataForHtml(StringBuilder html, StringBuilder source) {
+ final Map<String, List<String>> metaData;
+ final int endOffset; // end of metadata within source
+ // support two types of metadata:
+ if (source.toString().startsWith("---")) {
Review Comment:
Empty lines before are not allowed?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org