svn commit: r1721952 - /maven/doxia/site/trunk/content/apt/macros/index.apt

[hb...@apache.org]

Author: hboutemy
Date: Mon Dec 28 17:08:53 2015
New Revision: 1721952

URL: http://svn.apache.org/viewvc?rev=1721952&view=rev
Log:
[DOXIA-529] [DOXIA-492] added Macro support documentation for XHTML and Markdown

Modified:
    maven/doxia/site/trunk/content/apt/macros/index.apt

Modified: maven/doxia/site/trunk/content/apt/macros/index.apt
URL: http://svn.apache.org/viewvc/maven/doxia/site/trunk/content/apt/macros/index.apt?rev=1721952&r1=1721951&r2=1721952&view=diff
==============================================================================
--- maven/doxia/site/trunk/content/apt/macros/index.apt (original)
+++ maven/doxia/site/trunk/content/apt/macros/index.apt Mon Dec 28 17:08:53 2015
@@ -30,10 +30,9 @@ Doxia Macros Guide
 
  The Doxia <Core> includes macro mechanisms to facilitate the documentation writing.
 
- Macros are currently only supported for the standard Maven input formats APT and Xdoc.
- Support in FML files will be added in a
- {{{http://jira.codehaus.org/browse/DOXIA-281}future version}} of Doxia.
- Macros are not (and probably will never be) supported by Confluence, Docbook, Twiki and XHTML modules.
+ 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.
 
  A macro in an APT source file is a <<non-indented>> line that looks like this:
 
@@ -41,7 +40,7 @@ Doxia Macros Guide
 %{macro_name|param1=value1|param2=value2|...}
 +----
 
- An Xdoc macro has the following syntax:
+ An Xdoc or FML macro has the following syntax:
 
 +----
 <macro name="macro_name">
@@ -51,6 +50,12 @@ Doxia Macros Guide
 </macro>
 +----
 
+ Since Doxia 1.7, an XHTML or Markdown macro has the following syntax:
+
++----
+<!-- MACRO{macro_name|param1=value1|param2=value2|...} -->
++----
+
  As of Doxia 1.1, the following macros are available:
 
 %{toc|section=1|fromDepth=2|toDepth=2}