org.apache.maven.doxia.module.apt

Interface AptMarkup

public interface AptMarkup extends TextMarkup

This interface defines all markups and syntaxes used by the APT format.

Since: 1.0

Version: $Id: AptMarkup.java 572813 2007-09-04 20:46:47Z ltheussl $

Author: Vincent Siveton

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

Field Summary
StringANCHOR_END_MARKUP
Syntax for the anchor end: "}"
StringANCHOR_START_MARKUP
Syntax for the anchor start: "{"
charBACKSLASH
APT backslash markup char: '\\'
StringBOLD_END_MARKUP
Syntax for the bold style end: ">>"
StringBOLD_START_MARKUP
Syntax for the bold style start: "<<"
StringBOXED_VERBATIM_END_MARKUP
Syntax for the boxed verbatim end: "+------+"
StringBOXED_VERBATIM_START_MARKUP
Syntax for the boxed verbatim start: "+------+"
charCOLON
colon character: ':'
charCOMMENT
APT comment markup char: '~'
StringHEADER_START_MARKUP
Syntax for the header start: " -----"
StringHORIZONTAL_RULE_MARKUP
Syntax for the horizontal rule: "========"
StringITALIC_END_MARKUP
Syntax for the italic style end: ">"
StringITALIC_START_MARKUP
Syntax for the italic style start: "<"
StringLINK_END_MARKUP
Syntax for the link end: "}}"
StringLINK_START_1_MARKUP
Syntax for the link start: "{{{"
StringLINK_START_2_MARKUP
Syntax for the link start: "}"
StringLIST_END_MARKUP
Syntax for the list end: "[]"
StringLIST_START_MARKUP
Syntax for the list start: "*"
StringMONOSPACED_END_MARKUP
Syntax for the mono-spaced style end: ">>>"
StringMONOSPACED_START_MARKUP
Syntax for the mono-spaced style start: "<<<"
StringNON_BOXED_VERBATIM_END_MARKUP
Syntax for the non boxed verbatim end: "------"
StringNON_BOXED_VERBATIM_START_MARKUP
Syntax for the non boxed verbatim start: "------"
StringNON_BREAKING_SPACE_MARKUP
Syntax for the non breaking space: "\ "
charNUMBERING
APT numbering decimal markup char: '1'
charNUMBERING_LOWER_ALPHA_CHAR
APT numbering lower alpha markup char: 'a'
charNUMBERING_LOWER_ROMAN_CHAR
APT numbering lower roman markup char: 'i'
charNUMBERING_UPPER_ALPHA_CHAR
APT numbering upper alpha markup char: 'A'
charNUMBERING_UPPER_ROMAN_CHAR
APT numbering upper roman markup char: 'I'
charPAGE_BREAK
APT page break markup char: '\f'
StringPAGE_BREAK_MARKUP
Syntax for the page break: "\f"
charPERCENT
APT percent markup char: '%'
StringSECTION_TITLE_START_MARKUP
Syntax for the section title start: "*"
charTAB
APT tab markup char: '\t'
StringTABLE_CELL_SEPARATOR_MARKUP
Syntax for the table cell start: "|"
StringTABLE_COL_CENTERED_ALIGNED_MARKUP
Syntax for the table column, centered style: "-*"
StringTABLE_COL_LEFT_ALIGNED_MARKUP
Syntax for the table column, left style: "-+"
StringTABLE_COL_RIGHT_ALIGNED_MARKUP
Syntax for the table column, right style: "-:"
StringTABLE_ROW_SEPARATOR_MARKUP
Syntax for the table row end: "|"
StringTABLE_ROW_START_MARKUP
Syntax for the table row start: "*--"

Field Detail

ANCHOR_END_MARKUP

public String ANCHOR_END_MARKUP
Syntax for the anchor end: "}"

ANCHOR_START_MARKUP

public String ANCHOR_START_MARKUP
Syntax for the anchor start: "{"

BACKSLASH

public char BACKSLASH
APT backslash markup char: '\\'

BOLD_END_MARKUP

public String BOLD_END_MARKUP
Syntax for the bold style end: ">>"

BOLD_START_MARKUP

public String BOLD_START_MARKUP
Syntax for the bold style start: "<<"

BOXED_VERBATIM_END_MARKUP

public String BOXED_VERBATIM_END_MARKUP
Syntax for the boxed verbatim end: "+------+"

BOXED_VERBATIM_START_MARKUP

public String BOXED_VERBATIM_START_MARKUP
Syntax for the boxed verbatim start: "+------+"

COLON

public char COLON
colon character: ':'

COMMENT

public char COMMENT
APT comment markup char: '~'

HEADER_START_MARKUP

public String HEADER_START_MARKUP
Syntax for the header start: " -----"

HORIZONTAL_RULE_MARKUP

public String HORIZONTAL_RULE_MARKUP
Syntax for the horizontal rule: "========"

ITALIC_END_MARKUP

public String ITALIC_END_MARKUP
Syntax for the italic style end: ">"

ITALIC_START_MARKUP

public String ITALIC_START_MARKUP
Syntax for the italic style start: "<"

LINK_END_MARKUP

public String LINK_END_MARKUP
Syntax for the link end: "}}"

LINK_START_1_MARKUP

public String LINK_START_1_MARKUP
Syntax for the link start: "{{{"

LINK_START_2_MARKUP

public String LINK_START_2_MARKUP
Syntax for the link start: "}"

LIST_END_MARKUP

public String LIST_END_MARKUP
Syntax for the list end: "[]"

LIST_START_MARKUP

public String LIST_START_MARKUP
Syntax for the list start: "*"

MONOSPACED_END_MARKUP

public String MONOSPACED_END_MARKUP
Syntax for the mono-spaced style end: ">>>"

MONOSPACED_START_MARKUP

public String MONOSPACED_START_MARKUP
Syntax for the mono-spaced style start: "<<<"

NON_BOXED_VERBATIM_END_MARKUP

public String NON_BOXED_VERBATIM_END_MARKUP
Syntax for the non boxed verbatim end: "------"

NON_BOXED_VERBATIM_START_MARKUP

public String NON_BOXED_VERBATIM_START_MARKUP
Syntax for the non boxed verbatim start: "------"

NON_BREAKING_SPACE_MARKUP

public String NON_BREAKING_SPACE_MARKUP
Syntax for the non breaking space: "\ "

NUMBERING

public char NUMBERING
APT numbering decimal markup char: '1'

NUMBERING_LOWER_ALPHA_CHAR

public char NUMBERING_LOWER_ALPHA_CHAR
APT numbering lower alpha markup char: 'a'

NUMBERING_LOWER_ROMAN_CHAR

public char NUMBERING_LOWER_ROMAN_CHAR
APT numbering lower roman markup char: 'i'

NUMBERING_UPPER_ALPHA_CHAR

public char NUMBERING_UPPER_ALPHA_CHAR
APT numbering upper alpha markup char: 'A'

NUMBERING_UPPER_ROMAN_CHAR

public char NUMBERING_UPPER_ROMAN_CHAR
APT numbering upper roman markup char: 'I'

PAGE_BREAK

public char PAGE_BREAK
APT page break markup char: '\f'

PAGE_BREAK_MARKUP

public String PAGE_BREAK_MARKUP
Syntax for the page break: "\f"

PERCENT

public char PERCENT
APT percent markup char: '%'

SECTION_TITLE_START_MARKUP

public String SECTION_TITLE_START_MARKUP
Syntax for the section title start: "*"

TAB

public char TAB
APT tab markup char: '\t'

TABLE_CELL_SEPARATOR_MARKUP

public String TABLE_CELL_SEPARATOR_MARKUP
Syntax for the table cell start: "|"

TABLE_COL_CENTERED_ALIGNED_MARKUP

public String TABLE_COL_CENTERED_ALIGNED_MARKUP
Syntax for the table column, centered style: "-*"

TABLE_COL_LEFT_ALIGNED_MARKUP

public String TABLE_COL_LEFT_ALIGNED_MARKUP
Syntax for the table column, left style: "-+"

TABLE_COL_RIGHT_ALIGNED_MARKUP

public String TABLE_COL_RIGHT_ALIGNED_MARKUP
Syntax for the table column, right style: "-:"

TABLE_ROW_SEPARATOR_MARKUP

public String TABLE_ROW_SEPARATOR_MARKUP
Syntax for the table row end: "|"

TABLE_ROW_START_MARKUP

public String TABLE_ROW_START_MARKUP
Syntax for the table row start: "*--"
Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.