You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2026/08/16 13:54:21 UTC
(maven-doxia-site) branch master updated (3cd03ee -> 9c0c1b0)
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/maven-doxia-site.git
from 3cd03ee Give each reference page a single top-level heading
new 92d4d59 Drop the SWF and SSI macro documentation
new dbec57c Point the XHTML rows at the module that still exists
new 9c981a0 Describe the source repositories as they are today
new 77cad32 Advertise the current Doxia version on the front page
new 9c0c1b0 Remove the linkcheck profile
The 5 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
content/markdown/macros/index.md | 62 +++-------------------------
content/markdown/macros/swf-macro.md | 79 ------------------------------------
content/markdown/modules/index.md | 2 +-
content/markdown/references/index.md | 25 ++++++------
content/markdown/scm.md | 4 +-
pom.xml | 17 +-------
6 files changed, 23 insertions(+), 166 deletions(-)
delete mode 100644 content/markdown/macros/swf-macro.md
(maven-doxia-site) 02/05: Point the XHTML rows at the module that still exists
Posted by sl...@apache.org.
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-site.git
commit dbec57c72386beb4f09fe8d4475099ad000e8c21
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Sun Aug 16 12:44:09 2026 +0200
Point the XHTML rows at the module that still exists
The format table linked doxia-module-xhtml, removed in 2.0; the current module
is doxia-module-xhtml5. Source directory and parser id stay "xhtml" - only the
artifact was renamed. XHTML 1.0 joins the former-formats table.
That table declared four columns but supplied three separators, so "Removed
Since" never rendered at all.
Verified: mvn clean site -> former-formats table now renders 4 headers, 8 rows
---
content/markdown/modules/index.md | 2 +-
content/markdown/references/index.md | 25 +++++++++++++------------
2 files changed, 14 insertions(+), 13 deletions(-)
diff --git a/content/markdown/modules/index.md b/content/markdown/modules/index.md
index ae74f4a..486cf45 100644
--- a/content/markdown/modules/index.md
+++ b/content/markdown/modules/index.md
@@ -64,7 +64,7 @@ XDoc is a legacy format for document into a styled HTML document based on XHTML
## <a id="XHTML"></a>XHTML
-[XHTML](https://html.spec.whatwg.org/multipage/xhtml.html) is a markup language with the same expressions as HTML, but also conforms to XML syntax.
+[XHTML](https://html.spec.whatwg.org/multipage/xhtml.html) is a markup language with the same expressions as HTML, but also conforms to XML syntax. Doxia supports it through the `doxia-module-xhtml5` module; the earlier XHTML 1\.0 module was removed in Doxia 2\.0\.
**References**:
diff --git a/content/markdown/references/index.md b/content/markdown/references/index.md
index 98549cb..a5e65d9 100644
--- a/content/markdown/references/index.md
+++ b/content/markdown/references/index.md
@@ -32,7 +32,7 @@ The following table gives an overview of the markup languages currently supporte
- if a _Sink_ is available, it means you can generate output in this format.
-The source directory is the directory under which Maven expects source documents in this format (e.g. `src/site/apt/` 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.
+The source directory is the directory under which Maven expects source documents in this format (e.g. `src/site/apt/` 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.
|Format|Short description|Parser<br />(input)|Sink<br />(output)|Source Directory|File Extension|Doxia Module|Parser Id|
|---|---|---|---|---|---|---|---|
@@ -42,7 +42,7 @@ The source directory is the directory under which Maven expects source documents
|[FML](./fml-format.html)|FAQ Markup Language|||`fml`|`fml`|[`doxia-module-fml`](../doxia/doxia-modules/doxia-module-fml/)|`fml`|
|[Markdown](./markdown-format.html)|Markdown markup language|||`markdown`|`md`, `markdown`|[`doxia-module-markdown`](../doxia/doxia-modules/doxia-module-markdown/)|`markdown`|
|[Xdoc](./xdoc-format.html)|XML Documentation Format|||`xdoc`|`xml`|[`doxia-module-xdoc`](../doxia/doxia-modules/doxia-module-xdoc/)|`xdoc`|
-|[XHTML](../modules/index.html#XHTML)|Extensible Hypertext Markup Language|||`xhtml`|`xhtml`|[`doxia-module-xhtml`](../doxia/doxia-modules/doxia-module-xhtml/)|`xhtml`|
+|[XHTML5](../modules/index.html#XHTML)|Extensible Hypertext Markup Language, HTML5 serialisation|||`xhtml`|`xhtml`|[`doxia-module-xhtml5`](../doxia/doxia-modules/doxia-module-xhtml5/)|`xhtml`|
Note some modules are not included per default with the site plugin. Have a look at the available modules here: [https://repo.maven.apache.org/maven2/org/apache/maven/doxia/](https://repo.maven.apache.org/maven2/org/apache/maven/doxia/).
@@ -63,16 +63,17 @@ If you need to add module for the `maven-site-plugin` simply add it as a depende
</plugin>
```
-# Former Doxia Formats
+## Former Doxia Formats
The following table gives an overview of the formats which used to be supported mostly as Parser in former versions of Doxia:
-|Format|Short description|Doxia Module|Removed Since
-|---|---|---|
-|iText|iText PDF Library|[`doxia-module-itext`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-itext/)|2.0
-|FO|XSL formatting objects (XSL-FO)|[`doxia-module-fo`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-fo/)|2.0
-|LaTeX|LaTeX typesetting system|[`doxia-module-latex`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-latex/)|2.0
-|RTF|Microsoft Rich Text Format|[`doxia-module-rtf`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-rtf/)|2.0
-|Confluence|Confluence Enterprise Wiki|[`doxia-module-confluence`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-confluence/)|2.0
-|Simplified DocBook|Simplified DocBook XML Standard|[`doxia-module-docbook-simple`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-docbook-simple/)|2.0
-|TWiki|TWiki Structured Wiki|[`doxia-module-twiki`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-twiki/)|2.0
+|Format|Short description|Doxia Module|Removed Since|
+|---|---|---|---|
+|iText|iText PDF Library|[`doxia-module-itext`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-itext/)|2.0|
+|FO|XSL formatting objects (XSL-FO)|[`doxia-module-fo`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-fo/)|2.0|
+|LaTeX|LaTeX typesetting system|[`doxia-module-latex`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-latex/)|2.0|
+|RTF|Microsoft Rich Text Format|[`doxia-module-rtf`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-rtf/)|2.0|
+|Confluence|Confluence Enterprise Wiki|[`doxia-module-confluence`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-confluence/)|2.0|
+|Simplified DocBook|Simplified DocBook XML Standard|[`doxia-module-docbook-simple`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-docbook-simple/)|2.0|
+|TWiki|TWiki Structured Wiki|[`doxia-module-twiki`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-twiki/)|2.0|
+|XHTML|XHTML 1.0, superseded by the XHTML5 module|[`doxia-module-xhtml`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-xhtml/)|2.0|
(maven-doxia-site) 03/05: Describe the source repositories as they are today
Posted by sl...@apache.org.
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-site.git
commit 9c981a0dac58592f39d722f6bacd7c28b9ef75f5
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Sun Aug 16 12:44:22 2026 +0200
Describe the source repositories as they are today
The page presented the Git migration as an open decision and pointed at
git-wip-us.apache.org, which was retired in favour of GitBox. Doxia has been
Git-only for years, so the Subversion instructions go with it.
---
content/markdown/scm.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/content/markdown/scm.md b/content/markdown/scm.md
index 389d1cc..f8dca6c 100644
--- a/content/markdown/scm.md
+++ b/content/markdown/scm.md
@@ -23,9 +23,9 @@ under the License.
# Source Repository
-Maven Doxia projects use [Git](http://git-scm.com/) or [Subversion](http://subversion.apache.org/) to manage their source code: decisions to stay with Subversion or move to Git are tracked on [Maven's Wiki](https://cwiki.apache.org/confluence/display/MAVEN/Git+Migration).
+Maven Doxia projects use [Git](https://git-scm.com/) to manage their source code.
-Instructions on Subversion use can be found in the online book [Version Control with Subversion](http://svnbook.red-bean.com/). Instructions on Git use can be found in the online book [Pro Git](http://git-scm.com/book/). Instructions for using the Apache Software Foundation Git repositories are at [https://git-wip-us.apache.org](https://git-wip-us.apache.org/).
+Instructions on Git use can be found in the online book [Pro Git](https://git-scm.com/book/). The Apache Software Foundation hosts its Git repositories at [GitBox](https://gitbox.apache.org/), which is mirrored to [GitHub](https://github.com/apache/).
## Doxia Website
(maven-doxia-site) 05/05: Remove the linkcheck profile
Posted by sl...@apache.org.
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-site.git
commit 9c0c1b03ef8bc09cc28ef4ada5613c0c414820d3
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Sun Aug 16 12:45:05 2026 +0200
Remove the linkcheck profile
maven-linkcheck-plugin was retired and its repository archived, so the profile
could only ever resolve the 2011 release. Do not restore it without picking a
maintained link checker; the site build itself does not depend on it.
---
pom.xml | 15 ---------------
1 file changed, 15 deletions(-)
diff --git a/pom.xml b/pom.xml
index 54fc1b2..cb8fa35 100644
--- a/pom.xml
+++ b/pom.xml
@@ -304,19 +304,4 @@ under the License.
</plugins>
</reporting>
- <profiles>
- <profile>
- <id>linkcheck</id>
- <reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-linkcheck-plugin</artifactId>
- <version>1.2</version>
- </plugin>
- </plugins>
- </reporting>
- </profile>
- </profiles>
-
</project>
(maven-doxia-site) 04/05: Advertise the current Doxia version on the front page
Posted by sl...@apache.org.
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-site.git
commit 77cad32cd0119384a8d682f03bb314f127631dc8
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Sun Aug 16 12:45:05 2026 +0200
Advertise the current Doxia version on the front page
The index page renders doxiaVersion verbatim, so it told visitors the current
release was 2.0.0.
---
pom.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/pom.xml b/pom.xml
index ad08eca..54fc1b2 100644
--- a/pom.xml
+++ b/pom.xml
@@ -147,7 +147,7 @@ under the License.
<properties>
<!-- used from scm-publish-maven-plugin, parameter checkoutDirectory-->
<maven.site.path>doxia-site</maven.site.path>
- <doxiaVersion>2.0.0</doxiaVersion>
+ <doxiaVersion>2.1.0</doxiaVersion>
</properties>
<repositories>
(maven-doxia-site) 01/05: Drop the SWF and SSI macro documentation
Posted by sl...@apache.org.
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-site.git
commit 92d4d59d9ef67c6918c0b726ea71d34c4ef6d7ec
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Sun Aug 16 12:43:55 2026 +0200
Drop the SWF and SSI macro documentation
Both macros were removed in Doxia 2.0, but the guide still described them as
available and the SWF page documented Flash embedding in full. A short note
replaces them so readers arriving from an old link learn the macros are gone
rather than finding the syntax and trying it.
The intro also claimed macros are unsupported by the Confluence, Docbook and
Twiki modules; those modules no longer exist either.
---
content/markdown/macros/index.md | 62 +++-------------------------
content/markdown/macros/swf-macro.md | 79 ------------------------------------
2 files changed, 6 insertions(+), 135 deletions(-)
diff --git a/content/markdown/macros/index.md b/content/markdown/macros/index.md
index 9e46957..4b8e4c7 100644
--- a/content/markdown/macros/index.md
+++ b/content/markdown/macros/index.md
@@ -26,7 +26,7 @@ date: 2009-03-02
The Doxia _Core_ includes macro mechanisms to facilitate the documentation writing.
-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.
+Macros are supported by the APT, Xdoc, FML, XHTML and Markdown formats.
A macro in an APT source file is a **non-indented** line that looks like this:
@@ -50,7 +50,7 @@ Since Doxia 1\.7, an XHTML or Markdown macro has the following syntax:
<!-- MACRO{macro_name|param1=value1|param2=value2|...} -->
```
-As of Doxia 1\.7, the following macros are available:
+The following macros are available:
<!-- MACRO{toc|section=1|fromDepth=2|toDepth=2} -->
## <a id="Echo_Macro"></a>Echo Macro
@@ -170,58 +170,8 @@ From **Doxia 1\.1\.1** on you may also specify any of the html base attributes (
This can be used for styling the TOC via css.
-## <a id="SWF_Macro"></a>SWF Macro
+## <a id="Removed_Macros"></a>Removed Macros
-The _Swf_ macro prints Shockwave Flash assets in the documentation. For instance, in an APT file, you could write:
-
-```unknown
-%{swf|src=swf/myfile.swf|id=MyMovie|width=600|height=200}
-```
-
-In a xdoc file, it will be:
-
-```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>
-```
-
-|Parameter|Description|
-|:---|:---|
-|src|Specifies the location (URL) of the movie to be loaded.|
-|id|Identifies the Flash movie to the host environment (a web browser, for example) so that it can be referenced using a scripting language.|
-|width|Specifies the width of the movie in either pixels or percentage of browser window.|
-|height|Specifies the height of the movie in either pixels or percentage of browser window.|
-|quality|Possible values: low, high, autolow, autohigh, best.|
-|menu|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.|
-|loop|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.|
-|play|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.|
-|version|Specifies the width of the movie in either pixels or percentage of browser window.|
-|allowScript|Specifies the width of the movie in either pixels or percentage of browser window.|
-
-For more information, see the [SWF Macro](./swf-macro.html) page.
-
-## <a id="SSI_Macro"></a>SSI Macro
-
-Since Doxia 1\.7, the _SSI_ macro prints a server side include. For instance, in an APT file, you could write:
-
-```unknown
-%{ssi|function=include|file=included-file.html}
-```
-
-In a xdoc file, it will be:
-
-```unknown
-<macro name="ssi">
- <param name="function" value="include"/>
- <param name="file" value="included-file.html"/>
-</macro>
-```
-
-|Parameter|Description|
-|:---|:---|
-|function|The SSI function to insert.|
-|_any_|Parameter that will be added to the SSI directive.|
+The _SWF_ macro, which embedded Shockwave Flash assets, and the _SSI_ macro, which emitted a server
+side include, were both removed in Doxia 2\.0\. A document that still invokes either one fails to
+render.
diff --git a/content/markdown/macros/swf-macro.md b/content/markdown/macros/swf-macro.md
deleted file mode 100644
index 7f4e44f..0000000
--- a/content/markdown/macros/swf-macro.md
+++ /dev/null
@@ -1,79 +0,0 @@
----
-title: Doxia - SWF Macro
-author:
- - The Maven Team
-date: 2007-05-17
----
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one-->
-<!-- or more contributor license agreements. See the NOTICE file-->
-<!-- distributed with this work for additional information-->
-<!-- regarding copyright ownership. The ASF licenses this file-->
-<!-- to you under the Apache License, Version 2.0 (the-->
-<!-- "License"); you may not use this file except in compliance-->
-<!-- with the License. You may obtain a copy of the License at-->
-<!---->
-<!-- http://www.apache.org/licenses/LICENSE-2.0-->
-<!---->
-<!-- Unless required by applicable law or agreed to in writing,-->
-<!-- software distributed under the License is distributed on an-->
-<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
-<!-- KIND, either express or implied. See the License for the-->
-<!-- specific language governing permissions and limitations-->
-<!-- under the License.-->
-# SWF Macro
-
-The SWF macro enables users of APT to put SWF (Flash) assets in their documentation.
-
-Flash assets typically need to be wrappered in `object` and `embed` tags and can have a variety of parameters. Below is a typical example:
-
-```unknown
-<object classid='clsid:D27CDB6E-AE6D-11cf-96B8-444553540000'
- codebase='http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,29,0'
- width='400' height='400' id='MyMovie'>
- <param name='movie' value='myfile.swf'>
- <param name='quality' value='high'>
- <param name='menu' value='false'>
- <param name='loop' value='0'>
- <embed src='myfile.swf' width='400' height='400' loop='0' quality='high'
- pluginspage='http://www.macromedia.com/go/getflashplayer'
- type='application/x-shockwave-flash' menu='false'></embed>
-</object>
-```
-
-In order to use a \*.swf in your APT file, use the basic syntax:
-
-```unknown
-%{swf|src=swf/myfile.swf|id=MyMovie|width=600|height=200}
-```
-
-For which `src` is the required parameter. Make sure to put your \*.swf file into the **/resources** folder so that it will get copied to /target when running the `mvn site` task.
-
-You can use more advanced parameters to control the output, as per below:
-
-```unknown
-%{swf|src=swf/myfile.swf|id=MyMovie|width=600|height=200|version=9|allowScript=always}
-```
-
-For a full listing of parameters and their values see the Adobe knowledge base:
-
-[http://www.adobe.com/cfusion/knowledgebase/index.cfm?id=tn_12701](http://www.adobe.com/cfusion/knowledgebase/index.cfm?id=tn_12701)
-
-## Parameters and Defaults
-
-Currently the following parameters are available through the macro. If no value is placed within a parameter, the value will default to the following:
-
-- id = "swf"
-- width = "400"
-- height = "400"
-- quality = "high"
-- menu = "false"
-- loop = "0"
-- play = "true"
-- version = "9,0,45,0"
-- allowScript = "sameDomain"
-
-Note: There is some provided shorthand for versions, i.e. \- version=6 \- becomes version=6,0,29,0\.
-
-_TODO:_ only shorthand for 6 and 9 are functional. Need to find standard long version for other types.
-