Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add samples for macros

...

The following plugin config can be used to generate the Plexus component.xml file for the module containing your macro:

Code Block
        <build>
          ...
          <plugins>
            <plugin>
              <groupId>org.codehaus.plexus</groupId>
              <artifactId>plexus-maven-plugin</artifactId>
              <executions>
                <execution>
                  <goals>
                    <goal>descriptor</goal>
                  </goals>
                </execution>
              </executions>
            </plugin>
          ...
          </plugins>
        ...
        </build>

Using Doxia Macros by samples

Snippet

For instance, in apt file:

Code Block

%{snippet|id=superpom|url=http://svn.apache.org/repos/asf/maven/components/trunk/maven-project/src/main/resources/org/apache/maven/project/pom-4.0.0.xml}

And in xdoc file:

Code Block

<snippet id="superpom" url="http://svn.apache.org/repos/asf/maven/components/trunk/maven-project/src/main/resources/org/apache/maven/project/pom-4.0.0.xml"/>

Table Of Content (toc)

For instance, in APT file:

Code Block

%{toc|section=2|fromDepth=1|toDepth=2}

And in Xdoc file:

Code Block

<macro name="toc" section="1" fromDepth="1" toDepth="2"/>

From Javadoc:

section

Display the specificated section number or all sections if 0 (in this case, other paramaters are ignored).
Positive int, not mandatory, 0 by default.

fromDepth

Display the depth starting for the given section number.
Positive int, not mandatory, 0 by default.

toDepth

Display the depth ending for the given section number.
Positive int, not mandatory, 5 by default.