Class TWikiParser
java.lang.Object
org.apache.maven.doxia.parser.AbstractParser
org.apache.maven.doxia.parser.AbstractTextParser
org.apache.maven.doxia.module.twiki.TWikiParser
- All Implemented Interfaces:
LogEnabled
,Markup
,TextMarkup
,Parser
Parse the
twiki file format
- Since:
- 1.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
private final FormatedTextParser
Text parser.private final HRuleBlockParser
hruler parser.private final GenericListBlockParser
enumeration parser.private final ParagraphBlockParser
paragraph parser.private BlockParser[]
list of parsers to try to apply to the toplevelprivate final SectionBlockParser
section parser.private final TableBlockParser
table parser.private final TextParser
text parser.private final VerbatimBlockParser
verbatim parser.Fields inherited from interface org.apache.maven.doxia.markup.Markup
COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR
Fields inherited from interface org.apache.maven.doxia.parser.Parser
ROLE, TXT_TYPE, UNKNOWN_TYPE, XML_TYPE
Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup
PIPE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal String
getTitle
(List<Block> blocks, ByLineSource source) Guess a title for the page.protected void
init()
Initialize the parser.void
Parses the given source model and emits Doxia events into the given sink.final void
Parses the given source model and emits Doxia events into the given sink.parse
(ByLineSource source) parse.Methods inherited from class org.apache.maven.doxia.parser.AbstractTextParser
getType
Methods inherited from class org.apache.maven.doxia.parser.AbstractParser
doxiaVersion, enableLogging, executeMacro, getBasedir, getLog, getMacroManager, isEmitComments, isSecondParsing, parse, parse, setEmitComments, setSecondParsing
-
Field Details
-
EXTENSION_LENGTH
private static final int EXTENSION_LENGTH- See Also:
-
paraParser
paragraph parser. -
sectionParser
section parser. -
listParser
enumeration parser. -
formatTextParser
Text parser. -
textParser
text parser. This only works for xhtml output, but there is no way of transforming a wikiWord in another context. -
hrulerParser
hruler parser. -
tableParser
table parser. -
verbatimParser
verbatim parser. -
parsers
list of parsers to try to apply to the toplevel
-
-
Constructor Details
-
TWikiParser
public TWikiParser()Creates the TWikiParser.
-
-
Method Details
-
parse
parse.
- Parameters:
source
- source to parse.- Returns:
- the blocks that represent source.
- Throws:
ParseException
- on error.
-
parse
Parses the given source model and emits Doxia events into the given sink.- Specified by:
parse
in interfaceParser
- Overrides:
parse
in classAbstractParser
- Parameters:
source
- not null reader that provides the source document. You could usenewReader
methods fromReaderFactory
.sink
- A sink that consumes the Doxia events.- Throws:
ParseException
- if the model could not be parsed.
-
parse
Parses the given source model and emits Doxia events into the given sink.- Parameters:
source
- not null reader that provides the source document. You could usenewReader
methods fromReaderFactory
.sink
- A sink that consumes the Doxia events.reference
- the reference- Throws:
ParseException
- if the model could not be parsed.
-
getTitle
Guess a title for the page. It uses the first section that it finds. If it doesn't find any section tries to get it fromByLineReaderSource.getName()
- Parameters:
blocks
- blocks to parsesource
- source to parse- Returns:
- a title for a page
- Since:
- 1.1
-
init
protected void init()Initialize the parser. This is called first byAbstractParser.parse(java.io.Reader, org.apache.maven.doxia.sink.Sink)
and can be used to set the parser into a clear state so it can be re-used.- Overrides:
init
in classAbstractParser
-