1 package org.apache.maven.doxia.module.apt;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.apache.maven.doxia.markup.TextMarkup;
23 import org.codehaus.plexus.util.StringUtils;
24
25 /**
26 * This interface defines all markups and syntaxes used by the <b>APT</b> format.
27 *
28 * @see <a href="https://maven.apache.org/doxia/references/apt-format.html">https://maven.apache.org/doxia/references/apt-format.html</a>
29 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
30 * @since 1.0
31 */
32 @SuppressWarnings( "checkstyle:interfaceistype" )
33 public interface AptMarkup
34 extends TextMarkup
35 {
36 // ----------------------------------------------------------------------
37 // Markup separators
38 // ----------------------------------------------------------------------
39
40 /** APT backslash markup char: '\\' */
41 char BACKSLASH = '\\';
42
43 /** APT comment markup char: '~' */
44 char COMMENT = '~';
45
46 /** APT numbering decimal markup char: '1' */
47 char NUMBERING = '1';
48
49 /** APT numbering lower alpha markup char: 'a' */
50 char NUMBERING_LOWER_ALPHA_CHAR = 'a';
51
52 /** APT numbering lower roman markup char: 'i' */
53 char NUMBERING_LOWER_ROMAN_CHAR = 'i';
54
55 /** APT numbering upper alpha markup char: 'A' */
56 char NUMBERING_UPPER_ALPHA_CHAR = 'A';
57
58 /** APT numbering upper roman markup char: 'I' */
59 char NUMBERING_UPPER_ROMAN_CHAR = 'I';
60
61 /** APT page break markup char: '\f' */
62 char PAGE_BREAK = '\f';
63
64 /** APT percent markup char: '%' */
65 char PERCENT = '%';
66
67 /** APT tab markup char: '\t' */
68 char TAB = '\t';
69
70 // ----------------------------------------------------------------------
71 // Markup syntax
72 // ----------------------------------------------------------------------
73
74 /** Syntax for the anchor end: "}" */
75 String ANCHOR_END_MARKUP = String.valueOf( RIGHT_CURLY_BRACKET );
76
77 /** Syntax for the anchor start: "{" */
78 String ANCHOR_START_MARKUP = String.valueOf( LEFT_CURLY_BRACKET );
79
80 /** Syntax for the bold style end: ">>" */
81 String BOLD_END_MARKUP = StringUtils.repeat( String.valueOf( GREATER_THAN ), 2 );
82
83 /** Syntax for the bold style start: "<<" */
84 String BOLD_START_MARKUP = StringUtils.repeat( String.valueOf( LESS_THAN ), 2 );
85
86 /** Syntax for the boxed verbatim start: "+------+" */
87 String BOXED_VERBATIM_START_MARKUP = PLUS + StringUtils.repeat( String.valueOf( MINUS ), 6 ) + PLUS;
88
89 /** Syntax for the header start: " -----" */
90 String HEADER_START_MARKUP = SPACE + StringUtils.repeat( String.valueOf( MINUS ), 5 );
91
92 /** Syntax for the horizontal rule: "========" */
93 String HORIZONTAL_RULE_MARKUP = StringUtils.repeat( String.valueOf( EQUAL ), 8 );
94
95 /** Syntax for the italic style end: ">" */
96 String ITALIC_END_MARKUP = String.valueOf( GREATER_THAN );
97
98 /** Syntax for the italic style start: "<" */
99 String ITALIC_START_MARKUP = String.valueOf( LESS_THAN );
100
101 /** Syntax for the link end: "}}" */
102 String LINK_END_MARKUP = StringUtils.repeat( String.valueOf( RIGHT_CURLY_BRACKET ), 2 );
103
104 /** Syntax for the link start: "{{{" */
105 String LINK_START_1_MARKUP = StringUtils.repeat( String.valueOf( LEFT_CURLY_BRACKET ), 3 );
106
107 /** Syntax for the link start: "}" */
108 String LINK_START_2_MARKUP = String.valueOf( RIGHT_CURLY_BRACKET );
109
110 /** Syntax for the list end: "[]" */
111 String LIST_END_MARKUP = String.valueOf( LEFT_SQUARE_BRACKET ) + RIGHT_SQUARE_BRACKET;
112
113 /** Syntax for the list start: "*" */
114 String LIST_START_MARKUP = String.valueOf( STAR );
115
116 /** Syntax for the mono-spaced style end: ">>>" */
117 String MONOSPACED_END_MARKUP = StringUtils.repeat( String.valueOf( GREATER_THAN ), 3 );
118
119 /** Syntax for the mono-spaced style start: "<<<" */
120 String MONOSPACED_START_MARKUP = StringUtils.repeat( String.valueOf( LESS_THAN ), 3 );
121
122 /** Syntax for the non boxed verbatim start: "------" */
123 String NON_BOXED_VERBATIM_START_MARKUP = StringUtils.repeat( String.valueOf( MINUS ), 6 );
124
125 /** Syntax for the non breaking space: "\ " */
126 String NON_BREAKING_SPACE_MARKUP = String.valueOf( BACKSLASH ) + SPACE;
127
128 /** Syntax for the page break: "\f" */
129 String PAGE_BREAK_MARKUP = String.valueOf( PAGE_BREAK );
130
131 /** Syntax for the section title start: "*" */
132 String SECTION_TITLE_START_MARKUP = String.valueOf( STAR );
133
134 /** Syntax for the table cell start: "|" */
135 String TABLE_CELL_SEPARATOR_MARKUP = String.valueOf( PIPE );
136
137 /** Syntax for the table column, centered style: "-*" */
138 String TABLE_COL_CENTERED_ALIGNED_MARKUP = StringUtils.repeat( String.valueOf( MINUS ), 2 ) + STAR;
139
140 /** Syntax for the table column, left style: "-+" */
141 String TABLE_COL_LEFT_ALIGNED_MARKUP = StringUtils.repeat( String.valueOf( MINUS ), 2 ) + PLUS;
142
143 /** Syntax for the table column, right style: "-:" */
144 String TABLE_COL_RIGHT_ALIGNED_MARKUP = StringUtils.repeat( String.valueOf( MINUS ), 2 ) + COLON;
145
146 /** Syntax for the table row end: "|" */
147 String TABLE_ROW_SEPARATOR_MARKUP = String.valueOf( PIPE );
148
149 /** Syntax for the table row start: "*--" */
150 String TABLE_ROW_START_MARKUP = STAR + StringUtils.repeat( String.valueOf( MINUS ), 2 );
151
152 /** Syntax for the boxed verbatim end: "+------+" */
153 String BOXED_VERBATIM_END_MARKUP = BOXED_VERBATIM_START_MARKUP;
154
155 /** Syntax for the non boxed verbatim end: "------" */
156 String NON_BOXED_VERBATIM_END_MARKUP = NON_BOXED_VERBATIM_START_MARKUP;
157 }