1 package org.apache.maven.doxia.module.confluence;
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
24 /**
25 * This interface defines all markups and syntaxes used by the <b>Confluence</b> format.
26 *
27 * See <a href="http://confluence.atlassian.com/display/CONF25/Confluence+Notation+Guide+Overview">
28 * Confluence Notation Guide Overview</a>
29 *
30 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
31 * @version $Id: ConfluenceMarkup.java 706268 2008-10-20 12:49:35Z vsiveton $
32 * @since 1.0
33 */
34 public interface ConfluenceMarkup
35 extends TextMarkup
36 {
37 // ----------------------------------------------------------------------
38 // Confluence markups
39 // ----------------------------------------------------------------------
40
41 /** Syntax for the anchor : "{anchor:" */
42 String ANCHOR_START_MARKUP = "{anchor:";
43
44 /** Syntax for the anchor : "}" */
45 String ANCHOR_END_MARKUP = "}";
46
47 /** Syntax for the bold markup: "*" */
48 String BOLD_END_MARKUP = "*";
49
50 /** Syntax for the bold markup: "*" */
51 String BOLD_START_MARKUP = "*";
52
53 /** Syntax for the figure markup: "!" */
54 String FIGURE_END_MARKUP = "!";
55
56 /** Syntax for the figure markup: "!" */
57 String FIGURE_START_MARKUP = "!";
58
59 /** Syntax for the italic markup: "_" */
60 String ITALIC_END_MARKUP = "_";
61
62 /** Syntax for the italic markup: "_" */
63 String ITALIC_START_MARKUP = "_";
64
65 /** Syntax for the line break markup: "\\\\" */
66 String LINE_BREAK_MARKUP = "\\\\";
67
68 /** Syntax for the link end markup: "]" */
69 String LINK_END_MARKUP = "]";
70
71 /** Syntax for the link middle markup: "|" */
72 String LINK_MIDDLE_MARKUP = "|";
73
74 /** Syntax for the link start markup: "[" */
75 String LINK_START_MARKUP = "[";
76
77 /** Syntax for the list item markup: "* */
78 String LIST_ITEM_MARKUP = "* ";
79
80 /** Syntax for the mono-spaced style end: "{{" */
81 String MONOSPACED_END_MARKUP = "{{";
82
83 /** Syntax for the mono-spaced style start: "}}" */
84 String MONOSPACED_START_MARKUP = "}}";
85
86 /** Syntax for the numbering decimal markup char: "1." */
87 String NUMBERING_MARKUP = "1.";
88
89 /** Syntax for the table cell header end markup: "|" */
90 String TABLE_CELL_HEADER_END_MARKUP = "|";
91
92 /** Syntax for the table cell header start markup: "|" */
93 String TABLE_CELL_HEADER_START_MARKUP = "|";
94
95 /** Syntax for the table cell markup: "|" */
96 String TABLE_CELL_MARKUP = "|";
97
98 /** Syntax for the table row markup: "|" */
99 String TABLE_ROW_MARKUP = "|";
100 }