This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-doxia-sitetools.git
The following commit(s) were added to refs/heads/master by this push:
new 97bc763 Render index.vm.md as a Velocity template, like index.md.vm
97bc763 is described below
commit 97bc763cd9bfc92b3c06390fc66da84b995ad6fe
Author: Sylwester Lachiewicz <[email protected]>
AuthorDate: Tue Nov 3 10:36:11 2026 +0000
Render index.vm.md as a Velocity template, like index.md.vm
Editors pick the language from the last extension, so a template named
with .vm first opens as Markdown, APT or XDoc. A file named this way was
rendered as plain content to index.vm.html before.
Refs #309
---
.../doxia/siterenderer/DefaultSiteRenderer.java | 34 +++++++++++++++---
.../siterenderer/DocumentRenderingContext.java | 5 ++-
.../siterenderer/DefaultSiteRendererTest.java | 41 ++++++++++++++++++++++
3 files changed, 72 insertions(+), 8 deletions(-)
diff --git
a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
index 1b40e70..c468449 100644
---
a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
+++
b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
@@ -261,6 +261,7 @@ public class DefaultSiteRenderer implements Renderer {
for (String extension : module.getExtensions()) {
String fullExtension = "." + extension;
+ // *.<extension>, including the Velocity templates *.vm.<extension>
List<String> docs = filterExtensionIgnoreCase(allFiles,
fullExtension);
// *.<extension>.vm
@@ -279,7 +280,7 @@ public class DefaultSiteRenderer implements Renderer {
siteDirectory.getEditableSourceDirectories());
// TODO: DOXIA-111: we need a general filter here that knows
how to alter the context
- if (endsWithIgnoreCase(doc, ".vm")) {
+ if (isVelocityDocument(doc, extension)) {
docRenderingContext.setAttribute("velocity", "true");
}
@@ -527,10 +528,10 @@ public class DefaultSiteRenderer implements Renderer {
siteContext.getProcessedContentOutput().mkdirs();
}
- String inputPath = docRenderingContext.getInputName();
- // Remove .vm suffix
- File outputFile =
- new File(siteContext.getProcessedContentOutput(),
inputPath.substring(0, inputPath.length() - 3));
+ // the content as the parser reads it: index.md.vm and index.vm.md ->
index.md
+ File outputFile = new File(
+ siteContext.getProcessedContentOutput(),
+ withoutVelocityExtension(docRenderingContext.getInputName(),
docRenderingContext.getExtension()));
File outputParent = outputFile.getParentFile();
if (!outputParent.exists()) {
@@ -1125,6 +1126,29 @@ public class DefaultSiteRenderer implements Renderer {
}
}
+ /**
+ * Whether a document is a Velocity template: {@code index.md.vm}, or
{@code index.vm.md}, which editors open as
+ * Markdown.
+ */
+ static boolean isVelocityDocument(String document, String extension) {
+ return endsWithIgnoreCase(document, ".vm") ||
endsWithIgnoreCase(document, ".vm." + extension);
+ }
+
+ /**
+ * Removes the Velocity extension: {@code index.md.vm} and {@code
index.vm.md} give {@code index.md}.
+ */
+ static String withoutVelocityExtension(String document, String extension) {
+ if (endsWithIgnoreCase(document, ".vm")) {
+ return document.substring(0, document.length() - ".vm".length());
+ }
+ if (endsWithIgnoreCase(document, ".vm." + extension)) {
+ return document.substring(0, document.length() - (".vm." +
extension).length())
+ + '.'
+ + document.substring(document.length() -
extension.length());
+ }
+ return document;
+ }
+
// TODO replace with StringUtils.endsWithIgnoreCase() from
maven-shared-utils 0.7
static boolean endsWithIgnoreCase(String str, String searchStr) {
if (str.length() < searchStr.length()) {
diff --git
a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderingContext.java
b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderingContext.java
index e92d7a1..62a9673 100644
---
a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderingContext.java
+++
b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderingContext.java
@@ -250,9 +250,8 @@ public class DocumentRenderingContext {
// - index.xml -> index.html
// - index.xml.vm -> index.html
// - download.apt.vm --> download.html
- if (DefaultSiteRenderer.endsWithIgnoreCase(document, ".vm")) {
- document = document.substring(0, document.length() - 3);
- }
+ // - download.vm.apt --> download.html
+ document = DefaultSiteRenderer.withoutVelocityExtension(document,
extension);
String filePathWithoutExt = document.substring(0,
document.length() - extension.length() - 1);
this.outputPath = filePathWithoutExt + ".html";
} else {
diff --git
a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
index acde1b2..ac7d08c 100644
---
a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
+++
b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
@@ -35,6 +35,7 @@ import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.StandardCopyOption;
+import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
@@ -440,6 +441,46 @@ public class DefaultSiteRendererTest {
assertEquals(expectedOutputFiles, outputFiles);
}
+ @Test
+ void velocityExtensionBeforeOrAfterTheMarkupOne() throws Exception {
+ File siteDir = getTestFile("target/velocity-extension");
+ org.apache.commons.io.FileUtils.deleteDirectory(siteDir);
+ File markdown = new File(siteDir, "markdown");
+ markdown.mkdirs();
+ Files.write(
+ new File(markdown, "after.md.vm").toPath(),
+ "# After\n\n#set( $word = 'rendered' )Velocity
$word.\n".getBytes(StandardCharsets.UTF_8));
+ Files.write(
+ new File(markdown, "before.vm.md").toPath(),
+ "# Before\n\n#set( $word = 'rendered' )Velocity
$word.\n".getBytes(StandardCharsets.UTF_8));
+ Files.write(new File(markdown, "plain.md").toPath(), "#
Plain\n".getBytes(StandardCharsets.UTF_8));
+
+ SiteRenderingContext ctxt =
+ getSiteRenderingContext(new SiteModel(), minimalSkinJar,
"target/velocity-extension", false);
+ ctxt.setRootDirectory(getTestFile(""));
+ ctxt.setProcessedContentOutput(new File(siteDir, "processed"));
+ Map<String, DocumentRenderer> documents =
siteRenderer.locateDocumentFiles(ctxt);
+ assertEquals(new HashSet<>(Arrays.asList("after.html", "before.html",
"plain.html")), documents.keySet());
+
+ File output = new File(siteDir, "output");
+ siteRenderer.render(documents.values(), ctxt, output);
+ for (String page : new String[] {"after", "before"}) {
+ String html =
+ new String(Files.readAllBytes(new File(output, page +
".html").toPath()), StandardCharsets.UTF_8);
+ assertTrue(html.contains("Velocity rendered."), page);
+ assertTrue(new File(siteDir, "processed/" + page +
".md").isFile(), page);
+ }
+ }
+
+ @Test
+ void withoutVelocityExtension() {
+ assertEquals("index.md",
DefaultSiteRenderer.withoutVelocityExtension("index.md.vm", "md"));
+ assertEquals("index.md",
DefaultSiteRenderer.withoutVelocityExtension("index.vm.md", "md"));
+ assertEquals("dir/index.MD",
DefaultSiteRenderer.withoutVelocityExtension("dir/index.VM.MD", "md"));
+ assertEquals("index.md",
DefaultSiteRenderer.withoutVelocityExtension("index.md", "md"));
+ assertFalse(DefaultSiteRenderer.isVelocityDocument("index.md", "md"));
+ }
+
@Test
void locateDocumentFilesWithNameClashes() throws Exception {
SiteRenderingContext context = new SiteRenderingContext();