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 c2069d5  Read documents of any format from a shared source directory
c2069d5 is described below

commit c2069d58b50f13f6461e3bfffe15e12ea70f76db
Author: Sylwester Lachiewicz <[email protected]>
AuthorDate: Tue Nov 3 10:38:42 2026 +0000

    Read documents of any format from a shared source directory
    
    With SiteRenderingContext#setSharedSourceDirectory(true), src/site/source
    holds pages of every markup format and the file extension picks the
    parser. The format directories are read as well.
    
    Refs #309
---
 .../doxia/siterenderer/DefaultSiteRenderer.java    | 11 +++++++
 .../doxia/siterenderer/SiteRenderingContext.java   | 34 ++++++++++++++++++++
 .../siterenderer/DefaultSiteRendererTest.java      | 36 ++++++++++++++++++++++
 3 files changed, 81 insertions(+)

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 c468449..b893bf7 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
@@ -211,6 +211,17 @@ public class DefaultSiteRenderer implements Renderer {
                             module,
                             excludes,
                             files);
+
+                    // the shared directory: every module reads the files with 
its extensions
+                    if (siteRenderingContext.isSharedSourceDirectory()) {
+                        addModuleFiles(
+                                siteRenderingContext.getRootDirectory(),
+                                siteDirectory,
+                                new File(siteDirectoryPath, 
SiteRenderingContext.SHARED_SOURCE_DIRECTORY),
+                                module,
+                                excludes,
+                                files);
+                    }
                 }
             }
         }
diff --git 
a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java
 
b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java
index c244cff..9f349ca 100644
--- 
a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java
+++ 
b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java
@@ -145,6 +145,8 @@ public class SiteRenderingContext {
 
     private boolean deriveBreadcrumbsFromMenu;
 
+    private boolean sharedSourceDirectory;
+
     private Date publishDate;
 
     private File processedContentOutput;
@@ -174,6 +176,38 @@ public class SiteRenderingContext {
         this.validate = validate;
     }
 
+    /**
+     * The directory, under each site directory, that holds documents of any 
markup format when
+     * {@link #isSharedSourceDirectory()} is switched on.
+     *
+     * @since 2.2.0
+     */
+    public static final String SHARED_SOURCE_DIRECTORY = "source";
+
+    /**
+     * If documents are also read from the {@value #SHARED_SOURCE_DIRECTORY} 
directory of each site directory, such as
+     * <code>src/site/source</code>, where the file extension rather than the 
directory picks the parser:
+     * <code>index.md</code> is Markdown and <code>usage.apt</code> is APT. 
The format directories, such as
+     * <code>src/site/markdown</code>, are read as well; a page found in both 
fails as a duplicate.
+     * By default this is switched off.
+     *
+     * @return true if the shared source directory is read.
+     * @since 2.2.0
+     */
+    public boolean isSharedSourceDirectory() {
+        return sharedSourceDirectory;
+    }
+
+    /**
+     * Switch on/off reading documents from the shared {@value 
#SHARED_SOURCE_DIRECTORY} directory.
+     *
+     * @param sharedSourceDirectory true to read the shared source directory.
+     * @since 2.2.0
+     */
+    public void setSharedSourceDirectory(boolean sharedSourceDirectory) {
+        this.sharedSourceDirectory = sharedSourceDirectory;
+    }
+
     /**
      * If breadcrumbs should be derived from the site descriptor's menu 
hierarchy: the menus and menu items
      * that contain the document follow the declared (usually inherited) 
<code>&lt;breadcrumbs&gt;</code>,
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 ac7d08c..9aabaa4 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
@@ -481,6 +481,42 @@ public class DefaultSiteRendererTest {
         assertFalse(DefaultSiteRenderer.isVelocityDocument("index.md", "md"));
     }
 
+    @Test
+    void sharedSourceDirectoryPicksTheParserByExtension() throws Exception {
+        File siteDir = getTestFile("target/shared-source");
+        org.apache.commons.io.FileUtils.deleteDirectory(siteDir);
+        write(new File(siteDir, "source/index.md"), "# Markdown\n");
+        write(new File(siteDir, "source/guide/usage.apt"), "Usage\n\n* APT\n\n 
 Text.\n");
+        write(new File(siteDir, "source/faq.fml"), "<faqs title=\"FAQ\"/>\n");
+        write(new File(siteDir, "markdown/other.md"), "# Other\n");
+
+        SiteRenderingContext context = new SiteRenderingContext();
+        context.setRootDirectory(siteDir);
+        context.addSiteDirectory(new SiteDirectory(siteDir, true));
+        assertEquals(
+                Collections.singleton("other.html"),
+                siteRenderer.locateDocumentFiles(context).keySet());
+
+        context.setSharedSourceDirectory(true);
+        Map<String, DocumentRenderer> documents = 
siteRenderer.locateDocumentFiles(context);
+        assertEquals(
+                new HashSet<>(Arrays.asList("index.html", "guide/usage.html", 
"faq.html", "other.html")),
+                documents.keySet());
+        assertEquals(
+                "apt", 
documents.get("guide/usage.html").getRenderingContext().getParserId());
+        assertEquals(
+                "markdown", 
documents.get("index.html").getRenderingContext().getParserId());
+
+        // the same page in a format directory and the shared one is a 
duplicate
+        write(new File(siteDir, "markdown/index.md"), "# Again\n");
+        assertThrows(RendererException.class, () -> 
siteRenderer.locateDocumentFiles(context));
+    }
+
+    private static void write(File file, String content) throws IOException {
+        file.getParentFile().mkdirs();
+        Files.write(file.toPath(), content.getBytes(StandardCharsets.UTF_8));
+    }
+
     @Test
     void locateDocumentFilesWithNameClashes() throws Exception {
         SiteRenderingContext context = new SiteRenderingContext();

Reply via email to