You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by sv...@apache.org on 2026/08/16 13:56:04 UTC
svn commit: r1937158 - in maven/doxia/website/content: . developers macros modules references
Author: svn-site-role
Date: Sun Aug 16 13:56:04 2026
New Revision: 1937158
Log:
Site checkin for project Doxia Site
Deleted:
maven/doxia/website/content/macros/swf-macro.html
Modified:
maven/doxia/website/content/developers/modules.html
maven/doxia/website/content/index.html
maven/doxia/website/content/macros/index.html
maven/doxia/website/content/modules/index.html
maven/doxia/website/content/references/index.html
maven/doxia/website/content/scm.html
Modified: maven/doxia/website/content/developers/modules.html
==============================================================================
--- maven/doxia/website/content/developers/modules.html Sun Aug 16 13:54:27 2026 (r1937157)
+++ maven/doxia/website/content/developers/modules.html Sun Aug 16 13:56:04 2026 (r1937158)
@@ -127,7 +127,7 @@
<parent>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-modules</artifactId>
- <version>2.0.0</version> <!-- Latest release -->
+ <version>2.1.0</version> <!-- Latest release -->
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>doxia-module-my</artifactId>
Modified: maven/doxia/website/content/index.html
==============================================================================
--- maven/doxia/website/content/index.html Sun Aug 16 13:54:27 2026 (r1937157)
+++ maven/doxia/website/content/index.html Sun Aug 16 13:56:04 2026 (r1937158)
@@ -133,7 +133,7 @@
<p>Doxia is a content generation framework which aims to provide its users with powerful techniques for generating static and dynamic content: Doxia can be used in web-based publishing context to generate static sites, in addition to being incorporated into dynamic content generation systems like blogs, wikis and content management systems.</p>
<p>Doxia supports <a href="./references/index.html">markup languages with simple syntaxes</a>. Lightweight markup languages are used by people who might be expected to read the document source as well as the rendered output.</p>
<p>Doxia is used extensively by <a href="http://maven.apache.org" class="externalLink">Maven</a> and it powers the entire documentation system of Maven. It gives Maven the ability to take any document that Doxia supports and output it any format.</p>
-<p>The current version of <a href="./doxia/">Doxia base framework</a> is 2.0.0.</p><section><a id="Brief_History"></a>
+<p>The current version of <a href="./doxia/">Doxia base framework</a> is 2.1.0.</p><section><a id="Brief_History"></a>
<h2>Brief History</h2>
<p>Based on the (now defunct) Aptconvert project developed by <a href="http://www.xmlmind.com/" class="externalLink">Xmlmind</a>, Doxia was initially hosted by <a href="http://codehaus.org/" class="externalLink">Codehaus</a>, to become a sub-project of Maven early in 2006.</p></section><section><a id="Main_Features"></a>
<h2>Main Features</h2>
Modified: maven/doxia/website/content/macros/index.html
==============================================================================
--- maven/doxia/website/content/macros/index.html Sun Aug 16 13:54:27 2026 (r1937157)
+++ maven/doxia/website/content/macros/index.html Sun Aug 16 13:56:04 2026 (r1937158)
@@ -122,7 +122,7 @@
<section><a id="Doxia_Macros_Guide"></a>
<h1>Doxia Macros Guide</h1>
<p>The Doxia <em>Core</em> includes macro mechanisms to facilitate the documentation writing.</p>
-<p>Macros are currently only supported for APT, Xdoc and FML formats. Starting with Doxia 1.7 (maven-site-plugin 3.5), macros are also supported for XHTML and Markdown. Macros are not (and probably will never be) supported by Confluence, Docbook and Twiki modules.</p>
+<p>Macros are supported by the APT, Xdoc, FML, XHTML and Markdown formats.</p>
<p>A macro in an APT source file is a <strong>non-indented</strong> line that looks like this:</p>
<pre class="prettyprint linenums"><code class="language-unknown">%{macro_name|param1=value1|param2=value2|...}
@@ -139,13 +139,12 @@
<pre class="prettyprint linenums"><code class="language-unknown"><!-- MACRO{macro_name|param1=value1|param2=value2|...} -->
</code></pre>
-<p>As of Doxia 1.7, the following macros are available:</p>
+<p>The following macros are available:</p>
<ul>
<li><a href="#Echo_Macro">Echo Macro</a></li>
<li><a href="#Snippet_Macro">Snippet Macro</a></li>
<li><a href="#TOC_Macro">TOC Macro</a></li>
-<li><a href="#SWF_Macro">SWF Macro</a></li>
-<li><a href="#SSI_Macro">SSI Macro</a></li></ul>
+<li><a href="#Removed_Macros">Removed Macros</a></li></ul>
<section>
<h2><a id="Echo_Macro"></a>Echo Macro</h2>
<p>The <em>Echo</em> macro is a very simple macro: it prints out the key and value of any supplied parameters. For instance, in an APT file, you could write:</p>
@@ -267,82 +266,8 @@
<pre class="prettyprint linenums"><code class="language-unknown">%{toc|class=myTOC}
</code></pre>
<p>This can be used for styling the TOC via css.</p></section><section>
-<h2><a id="SWF_Macro"></a>SWF Macro</h2>
-<p>The <em>Swf</em> macro prints Shockwave Flash assets in the documentation. For instance, in an APT file, you could write:</p>
-
-<pre class="prettyprint linenums"><code class="language-unknown">%{swf|src=swf/myfile.swf|id=MyMovie|width=600|height=200}
-</code></pre>
-<p>In a xdoc file, it will be:</p>
-
-<pre class="prettyprint linenums"><code class="language-unknown"><macro name="swf">
- <param name="src" value="swf/myfile.swf"/>
- <param name="id" value="MyMovie"/>
- <param name="width" value="600"/>
- <param name="height" value="200"/>
-</macro>
-</code></pre>
-<table class="table table-striped">
-<thead>
-<tr class="a">
-<th>Parameter</th>
-<th>Description</th></tr></thead><tbody>
-<tr class="b">
-<td>src</td>
-<td>Specifies the location (URL) of the movie to be loaded.</td></tr>
-<tr class="a">
-<td>id</td>
-<td>Identifies the Flash movie to the host environment (a web browser, for example) so that it can be referenced using a scripting language.</td></tr>
-<tr class="b">
-<td>width</td>
-<td>Specifies the width of the movie in either pixels or percentage of browser window.</td></tr>
-<tr class="a">
-<td>height</td>
-<td>Specifies the height of the movie in either pixels or percentage of browser window.</td></tr>
-<tr class="b">
-<td>quality</td>
-<td>Possible values: low, high, autolow, autohigh, best.</td></tr>
-<tr class="a">
-<td>menu</td>
-<td>True displays the full menu, allowing the user a variety of options to enhance or control playback. False displays a menu that contains only the Settings option and the About Flash option.</td></tr>
-<tr class="b">
-<td>loop</td>
-<td>Possible values: true, false. Specifies whether the movie repeats indefinitely or stops when it reaches the last frame. The default value is true if this attribute is omitted.</td></tr>
-<tr class="a">
-<td>play</td>
-<td>Possible values: true, false. Specifies whether the movie begins playing immediately on loading in the browser. The default value is true if this attribute is omitted.</td></tr>
-<tr class="b">
-<td>version</td>
-<td>Specifies the width of the movie in either pixels or percentage of browser window.</td></tr>
-<tr class="a">
-<td>allowScript</td>
-<td>Specifies the width of the movie in either pixels or percentage of browser window.</td></tr></tbody>
-</table>
-
-<p>For more information, see the <a href="./swf-macro.html">SWF Macro</a> page.</p></section><section>
-<h2><a id="SSI_Macro"></a>SSI Macro</h2>
-<p>Since Doxia 1.7, the <em>SSI</em> macro prints a server side include. For instance, in an APT file, you could write:</p>
-
-<pre class="prettyprint linenums"><code class="language-unknown">%{ssi|function=include|file=included-file.html}
-</code></pre>
-<p>In a xdoc file, it will be:</p>
-
-<pre class="prettyprint linenums"><code class="language-unknown"><macro name="ssi">
- <param name="function" value="include"/>
- <param name="file" value="included-file.html"/>
-</macro>
-</code></pre>
-<table class="table table-striped">
-<thead>
-<tr class="a">
-<th>Parameter</th>
-<th>Description</th></tr></thead><tbody>
-<tr class="b">
-<td>function</td>
-<td>The SSI function to insert.</td></tr>
-<tr class="a">
-<td><em>any</em></td>
-<td>Parameter that will be added to the SSI directive.</td></tr></tbody>
-</table></section></section> </main>
+<h2><a id="Removed_Macros"></a>Removed Macros</h2>
+<p>The <em>SWF</em> macro, which embedded Shockwave Flash assets, and the <em>SSI</em> macro, which emitted a server side include, were both removed in Doxia 2.0. A document that still invokes either one fails to render.</p></section></section> </main>
</div>
</div>
<hr/>
Modified: maven/doxia/website/content/modules/index.html
==============================================================================
--- maven/doxia/website/content/modules/index.html Sun Aug 16 13:54:27 2026 (r1937157)
+++ maven/doxia/website/content/modules/index.html Sun Aug 16 13:56:04 2026 (r1937158)
@@ -160,7 +160,7 @@
<li><a href="../references/xdoc-format.html">XDoc Reference</a></li>
</ul></section><section>
<h2><a id="XHTML"></a>XHTML</h2>
-<p><a href="https://html.spec.whatwg.org/multipage/xhtml.html" class="externalLink">XHTML</a> is a markup language with the same expressions as HTML, but also conforms to XML syntax.</p>
+<p><a href="https://html.spec.whatwg.org/multipage/xhtml.html" class="externalLink">XHTML</a> is a markup language with the same expressions as HTML, but also conforms to XML syntax. Doxia supports it through the <code>doxia-module-xhtml5</code> module; the earlier XHTML 1.0 module was removed in Doxia 2.0.</p>
<p><strong>References</strong>:</p>
<ul>
Modified: maven/doxia/website/content/references/index.html
==============================================================================
--- maven/doxia/website/content/references/index.html Sun Aug 16 13:54:27 2026 (r1937157)
+++ maven/doxia/website/content/references/index.html Sun Aug 16 13:56:04 2026 (r1937158)
@@ -135,7 +135,7 @@
<li>
<p>if a <em>Sink</em> is available, it means you can generate output in this format.</p></li>
</ul>
-<p>The source directory is the directory under which Maven expects source documents in this format (e.g. <code>src/site/apt/</code> for Apt), the file extension is the default file extension, and the parser id is gives the unique identifier that is used by plexus to lookup the corresponding component.</p>
+<p>The source directory is the directory under which Maven expects source documents in this format (e.g. <code>src/site/apt/</code> for Apt), the file extension is the default file extension, and the parser id is the unique identifier used to look up the corresponding component.</p>
<table class="table table-striped">
<thead>
<tr class="a">
@@ -202,13 +202,13 @@
<td><a href="../doxia/doxia-modules/doxia-module-xdoc/"><code>doxia-module-xdoc</code></a></td>
<td><code>xdoc</code></td></tr>
<tr class="b">
-<td><a href="../modules/index.html#XHTML">XHTML</a></td>
-<td>Extensible Hypertext Markup Language</td>
+<td><a href="../modules/index.html#XHTML">XHTML5</a></td>
+<td>Extensible Hypertext Markup Language, HTML5 serialisation</td>
<td><img src="../images/icon_success_sml.gif" alt="Yes" /></td>
<td><img src="../images/icon_success_sml.gif" alt="Yes" /></td>
<td><code>xhtml</code></td>
<td><code>xhtml</code></td>
-<td><a href="../doxia/doxia-modules/doxia-module-xhtml/"><code>doxia-module-xhtml</code></a></td>
+<td><a href="../doxia/doxia-modules/doxia-module-xhtml5/"><code>doxia-module-xhtml5</code></a></td>
<td><code>xhtml</code></td></tr></tbody>
</table>
@@ -227,8 +227,8 @@
</dependency>
</dependencies>
</plugin>
-</code></pre></section><section><a id="Former_Doxia_Formats"></a>
-<h1>Former Doxia Formats</h1>
+</code></pre><section><a id="Former_Doxia_Formats"></a>
+<h2>Former Doxia Formats</h2>
<p>The following table gives an overview of the formats which used to be supported mostly as Parser in former versions of Doxia:</p>
<table class="table table-striped">
<thead>
@@ -271,8 +271,13 @@
<td>TWiki</td>
<td>TWiki Structured Wiki</td>
<td><a href="../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-twiki/"><code>doxia-module-twiki</code></a></td>
+<td>2.0</td></tr>
+<tr class="a">
+<td>XHTML</td>
+<td>XHTML 1.0, superseded by the XHTML5 module</td>
+<td><a href="../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-xhtml/"><code>doxia-module-xhtml</code></a></td>
<td>2.0</td></tr></tbody>
-</table></section> </main>
+</table></section></section> </main>
</div>
</div>
<hr/>
Modified: maven/doxia/website/content/scm.html
==============================================================================
--- maven/doxia/website/content/scm.html Sun Aug 16 13:54:27 2026 (r1937157)
+++ maven/doxia/website/content/scm.html Sun Aug 16 13:56:04 2026 (r1937158)
@@ -127,8 +127,8 @@
<main id="bodyColumn" class="span10">
<section><a id="Source_Repository"></a>
<h1>Source Repository</h1>
-<p>Maven Doxia projects use <a href="http://git-scm.com/" class="externalLink">Git</a> or <a href="http://subversion.apache.org/" class="externalLink">Subversion</a> to manage their source code: decisions to stay with Subversion or move to Git are tracked on <a href="https://cwiki.apache.org/confluence/display/MAVEN/Git+Migration" class="externalLink">Maven's Wiki</a>.</p>
-<p>Instructions on Subversion use can be found in the online book <a href="http://svnbook.red-bean.com/" class="externalLink">Version Control with Subversion</a>. Instructions on Git use can be found in the online book <a href="http://git-scm.com/book/" class="externalLink">Pro Git</a>. Instructions for using the Apache Software Foundation Git repositories are at <a href="https://git-wip-us.apache.org/" class="externalLink">https://git-wip-us.apache.org</a>.</p><section><a id="Doxia_Website"></a>
+<p>Maven Doxia projects use <a href="https://git-scm.com/" class="externalLink">Git</a> to manage their source code.</p>
+<p>Instructions on Git use can be found in the online book <a href="https://git-scm.com/book/" class="externalLink">Pro Git</a>. The Apache Software Foundation hosts its Git repositories at <a href="https://gitbox.apache.org/" class="externalLink">GitBox</a>, which is mirrored to <a href="https://github.com/apache/" class="externalLink">GitHub</a>.</p><section><a id="Doxia_Website"></a>
<h2>Doxia Website</h2>
<p>The sources for this site are available in a separate Git repository:</p>
<table class="table table-striped">