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 11:14:30 UTC
(maven-doxia-site) 01/05: Drop the SWF and SSI macro documentation
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch fix-doc-rot
in repository https://gitbox.apache.org/repos/asf/maven-doxia-site.git
commit b20da3d9719593bc60a92d0f547aa613d54d55dc
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.
-