AptMarkup (Doxia 1.8 API)

All Superinterfaces:

Markup, TextMarkup

All Known Implementing Classes:

AptParser, AptSink
```
public interface AptMarkup
extends TextMarkup
```
This interface defines all markups and syntaxes used by the APT format.

Since:

1.0

Version:

$Id$

Author:

Vincent Siveton

See Also:
http://maven.apache.org/doxia/references/apt-format.html

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ANCHOR_END_MARKUP` Syntax for the anchor end: "}"
`static String`	`ANCHOR_START_MARKUP` Syntax for the anchor start: "{"
`static char`	`BACKSLASH` APT backslash markup char: '\\'
`static String`	`BOLD_END_MARKUP` Syntax for the bold style end: ">>"
`static String`	`BOLD_START_MARKUP` Syntax for the bold style start: "<<"
`static String`	`BOXED_VERBATIM_END_MARKUP` Syntax for the boxed verbatim end: "+------+"
`static String`	`BOXED_VERBATIM_START_MARKUP` Syntax for the boxed verbatim start: "+------+"
`static char`	`COMMENT` APT comment markup char: '~'
`static String`	`HEADER_START_MARKUP` Syntax for the header start: " -----"
`static String`	`HORIZONTAL_RULE_MARKUP` Syntax for the horizontal rule: "========"
`static String`	`ITALIC_END_MARKUP` Syntax for the italic style end: ">"
`static String`	`ITALIC_START_MARKUP` Syntax for the italic style start: "<"
`static String`	`LINK_END_MARKUP` Syntax for the link end: "}}"
`static String`	`LINK_START_1_MARKUP` Syntax for the link start: "{{{"
`static String`	`LINK_START_2_MARKUP` Syntax for the link start: "}"
`static String`	`LIST_END_MARKUP` Syntax for the list end: "[]"
`static String`	`LIST_START_MARKUP` Syntax for the list start: "*"
`static String`	`MONOSPACED_END_MARKUP` Syntax for the mono-spaced style end: ">>>"
`static String`	`MONOSPACED_START_MARKUP` Syntax for the mono-spaced style start: "<<<"
`static String`	`NON_BOXED_VERBATIM_END_MARKUP` Syntax for the non boxed verbatim end: "------"
`static String`	`NON_BOXED_VERBATIM_START_MARKUP` Syntax for the non boxed verbatim start: "------"
`static String`	`NON_BREAKING_SPACE_MARKUP` Syntax for the non breaking space: "\ "
`static char`	`NUMBERING` APT numbering decimal markup char: '1'
`static char`	`NUMBERING_LOWER_ALPHA_CHAR` APT numbering lower alpha markup char: 'a'
`static char`	`NUMBERING_LOWER_ROMAN_CHAR` APT numbering lower roman markup char: 'i'
`static char`	`NUMBERING_UPPER_ALPHA_CHAR` APT numbering upper alpha markup char: 'A'
`static char`	`NUMBERING_UPPER_ROMAN_CHAR` APT numbering upper roman markup char: 'I'
`static char`	`PAGE_BREAK` APT page break markup char: '\f'
`static String`	`PAGE_BREAK_MARKUP` Syntax for the page break: "\f"
`static char`	`PERCENT` APT percent markup char: '%'
`static String`	`SECTION_TITLE_START_MARKUP` Syntax for the section title start: "*"
`static char`	`TAB` APT tab markup char: '\t'
`static String`	`TABLE_CELL_SEPARATOR_MARKUP` Syntax for the table cell start: "\|"
`static String`	`TABLE_COL_CENTERED_ALIGNED_MARKUP` Syntax for the table column, centered style: "-*"
`static String`	`TABLE_COL_LEFT_ALIGNED_MARKUP` Syntax for the table column, left style: "-+"
`static String`	`TABLE_COL_RIGHT_ALIGNED_MARKUP` Syntax for the table column, right style: "-:"
`static String`	`TABLE_ROW_SEPARATOR_MARKUP` Syntax for the table row end: "\|"
`static String`	`TABLE_ROW_START_MARKUP` Syntax for the table row start: "*--"

Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup
PIPE

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

- Field Detail
  - BACKSLASH
```
static final char BACKSLASH
```
    APT backslash markup char: '\\'
    
    See Also:
    Constant Field Values
  - COMMENT
```
static final char COMMENT
```
    APT comment markup char: '~'
    
    See Also:
    Constant Field Values
  - NUMBERING
```
static final char NUMBERING
```
    APT numbering decimal markup char: '1'
    
    See Also:
    Constant Field Values
  - NUMBERING_LOWER_ALPHA_CHAR
```
static final char NUMBERING_LOWER_ALPHA_CHAR
```
    APT numbering lower alpha markup char: 'a'
    
    See Also:
    Constant Field Values
  - NUMBERING_LOWER_ROMAN_CHAR
```
static final char NUMBERING_LOWER_ROMAN_CHAR
```
    APT numbering lower roman markup char: 'i'
    
    See Also:
    Constant Field Values
  - NUMBERING_UPPER_ALPHA_CHAR
```
static final char NUMBERING_UPPER_ALPHA_CHAR
```
    APT numbering upper alpha markup char: 'A'
    
    See Also:
    Constant Field Values
  - NUMBERING_UPPER_ROMAN_CHAR
```
static final char NUMBERING_UPPER_ROMAN_CHAR
```
    APT numbering upper roman markup char: 'I'
    
    See Also:
    Constant Field Values
  - PAGE_BREAK
```
static final char PAGE_BREAK
```
    APT page break markup char: '\f'
    
    See Also:
    Constant Field Values
  - PERCENT
```
static final char PERCENT
```
    APT percent markup char: '%'
    
    See Also:
    Constant Field Values
  - TAB
```
static final char TAB
```
    APT tab markup char: '\t'
    
    See Also:
    Constant Field Values
  - ANCHOR_END_MARKUP
```
static final String ANCHOR_END_MARKUP
```
    Syntax for the anchor end: "}"
  - ANCHOR_START_MARKUP
```
static final String ANCHOR_START_MARKUP
```
    Syntax for the anchor start: "{"
  - BOLD_END_MARKUP
```
static final String BOLD_END_MARKUP
```
    Syntax for the bold style end: ">>"
  - BOLD_START_MARKUP
```
static final String BOLD_START_MARKUP
```
    Syntax for the bold style start: "<<"
  - BOXED_VERBATIM_START_MARKUP
```
static final String BOXED_VERBATIM_START_MARKUP
```
    Syntax for the boxed verbatim start: "+------+"
  - HEADER_START_MARKUP
```
static final String HEADER_START_MARKUP
```
    Syntax for the header start: " -----"
  - HORIZONTAL_RULE_MARKUP
```
static final String HORIZONTAL_RULE_MARKUP
```
    Syntax for the horizontal rule: "========"
  - ITALIC_END_MARKUP
```
static final String ITALIC_END_MARKUP
```
    Syntax for the italic style end: ">"
  - ITALIC_START_MARKUP
```
static final String ITALIC_START_MARKUP
```
    Syntax for the italic style start: "<"
  - LINK_END_MARKUP
```
static final String LINK_END_MARKUP
```
    Syntax for the link end: "}}"
  - LINK_START_1_MARKUP
```
static final String LINK_START_1_MARKUP
```
    Syntax for the link start: "{{{"
  - LINK_START_2_MARKUP
```
static final String LINK_START_2_MARKUP
```
    Syntax for the link start: "}"
  - LIST_END_MARKUP
```
static final String LIST_END_MARKUP
```
    Syntax for the list end: "[]"
  - LIST_START_MARKUP
```
static final String LIST_START_MARKUP
```
    Syntax for the list start: "*"
  - MONOSPACED_END_MARKUP
```
static final String MONOSPACED_END_MARKUP
```
    Syntax for the mono-spaced style end: ">>>"
  - MONOSPACED_START_MARKUP
```
static final String MONOSPACED_START_MARKUP
```
    Syntax for the mono-spaced style start: "<<<"
  - NON_BOXED_VERBATIM_START_MARKUP
```
static final String NON_BOXED_VERBATIM_START_MARKUP
```
    Syntax for the non boxed verbatim start: "------"
  - NON_BREAKING_SPACE_MARKUP
```
static final String NON_BREAKING_SPACE_MARKUP
```
    Syntax for the non breaking space: "\ "
  - PAGE_BREAK_MARKUP
```
static final String PAGE_BREAK_MARKUP
```
    Syntax for the page break: "\f"
  - SECTION_TITLE_START_MARKUP
```
static final String SECTION_TITLE_START_MARKUP
```
    Syntax for the section title start: "*"
  - TABLE_CELL_SEPARATOR_MARKUP
```
static final String TABLE_CELL_SEPARATOR_MARKUP
```
    Syntax for the table cell start: "|"
  - TABLE_COL_CENTERED_ALIGNED_MARKUP
```
static final String TABLE_COL_CENTERED_ALIGNED_MARKUP
```
    Syntax for the table column, centered style: "-*"
  - TABLE_COL_LEFT_ALIGNED_MARKUP
```
static final String TABLE_COL_LEFT_ALIGNED_MARKUP
```
    Syntax for the table column, left style: "-+"
  - TABLE_COL_RIGHT_ALIGNED_MARKUP
```
static final String TABLE_COL_RIGHT_ALIGNED_MARKUP
```
    Syntax for the table column, right style: "-:"
  - TABLE_ROW_SEPARATOR_MARKUP
```
static final String TABLE_ROW_SEPARATOR_MARKUP
```
    Syntax for the table row end: "|"
  - TABLE_ROW_START_MARKUP
```
static final String TABLE_ROW_START_MARKUP
```
    Syntax for the table row start: "*--"
  - BOXED_VERBATIM_END_MARKUP
```
static final String BOXED_VERBATIM_END_MARKUP
```
    Syntax for the boxed verbatim end: "+------+"
  - NON_BOXED_VERBATIM_END_MARKUP
```
static final String NON_BOXED_VERBATIM_END_MARKUP
```
    Syntax for the non boxed verbatim end: "------"

Interface AptMarkup

Field Summary

Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup

Fields inherited from interface org.apache.maven.doxia.markup.Markup

Field Detail

BACKSLASH

COMMENT

NUMBERING

NUMBERING_LOWER_ALPHA_CHAR

NUMBERING_LOWER_ROMAN_CHAR

NUMBERING_UPPER_ALPHA_CHAR

NUMBERING_UPPER_ROMAN_CHAR

PAGE_BREAK

PERCENT

TAB

ANCHOR_END_MARKUP

ANCHOR_START_MARKUP

BOLD_END_MARKUP

BOLD_START_MARKUP

BOXED_VERBATIM_START_MARKUP

HEADER_START_MARKUP

HORIZONTAL_RULE_MARKUP

ITALIC_END_MARKUP

ITALIC_START_MARKUP

LINK_END_MARKUP

LINK_START_1_MARKUP

LINK_START_2_MARKUP

LIST_END_MARKUP

LIST_START_MARKUP

MONOSPACED_END_MARKUP

MONOSPACED_START_MARKUP

NON_BOXED_VERBATIM_START_MARKUP

NON_BREAKING_SPACE_MARKUP

PAGE_BREAK_MARKUP

SECTION_TITLE_START_MARKUP

TABLE_CELL_SEPARATOR_MARKUP

TABLE_COL_CENTERED_ALIGNED_MARKUP

TABLE_COL_LEFT_ALIGNED_MARKUP

TABLE_COL_RIGHT_ALIGNED_MARKUP

TABLE_ROW_SEPARATOR_MARKUP

TABLE_ROW_START_MARKUP

BOXED_VERBATIM_END_MARKUP

NON_BOXED_VERBATIM_END_MARKUP