@Singleton @Named(value="toc") public class TocMacro extends AbstractMacro
Table Of Content
in a given Sink
.
The input parameters for this macro are:
* {SubSection 1}Similarly, in an XDOC file, you could write:
<macro name="toc"> <param name="section" value="1" /> <param name="fromDepth" value="1" /> <param name="toDepth" value="2" /> </macro>
Constructor and Description |
---|
TocMacro() |
Modifier and Type | Method and Description |
---|---|
void |
execute(Sink sink,
MacroRequest request)
Execute the current macro using the given MacroRequest,
and emit events into the given sink.
|
getAttributesFromMap
public TocMacro()
public void execute(Sink sink, MacroRequest request) throws MacroExecutionException
sink
- The sink to receive the events.request
- The corresponding MacroRequest.MacroExecutionException
- if an error occurred during execution.Copyright © 2005–2024 The Apache Software Foundation. All rights reserved.