View Javadoc
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 1633964 2014-10-23 22:01:01Z hboutemy $
32   * @since 1.0
33   */
34  @SuppressWarnings( "checkstyle:interfaceistype" )
35  public interface ConfluenceMarkup
36      extends TextMarkup
37  {
38      // ----------------------------------------------------------------------
39      // Confluence markups
40      // ----------------------------------------------------------------------
41  
42      /** Syntax for the anchor : "{anchor:" */
43      String ANCHOR_START_MARKUP = "{anchor:";
44  
45      /** Syntax for the anchor : "}" */
46      String ANCHOR_END_MARKUP = "}";
47  
48      /** Syntax for the bold markup: "*" */
49      String BOLD_END_MARKUP = "*";
50  
51      /** Syntax for the bold markup: "*" */
52      String BOLD_START_MARKUP = "*";
53  
54      /** Syntax for the figure markup: "!" */
55      String FIGURE_END_MARKUP = "!";
56  
57      /** Syntax for the figure markup: "!" */
58      String FIGURE_START_MARKUP = "!";
59  
60      /** Syntax for the italic markup: "_" */
61      String ITALIC_END_MARKUP = "_";
62  
63      /** Syntax for the italic markup: "_" */
64      String ITALIC_START_MARKUP = "_";
65  
66      /** Syntax for the line break markup: "\\\\" */
67      String LINE_BREAK_MARKUP = "\\\\";
68  
69      /** Syntax for the link end markup: "]" */
70      String LINK_END_MARKUP = "]";
71  
72      /** Syntax for the link middle markup: "|" */
73      String LINK_MIDDLE_MARKUP = "|";
74  
75      /** Syntax for the link start markup: "[" */
76      String LINK_START_MARKUP = "[";
77  
78      /** Syntax for the list item markup: "* */
79      String LIST_ITEM_MARKUP = "* ";
80  
81      /** Syntax for the mono-spaced style start: "{{" */
82      String MONOSPACED_START_MARKUP = "{{";
83  
84      /** Syntax for the mono-spaced style end: "}}" */
85      String MONOSPACED_END_MARKUP = "}}";
86  
87      /** Syntax for the numbering decimal markup char: "#" */
88      String NUMBERING_MARKUP = "#";
89  
90      /** Syntax for the strikethrough markup start: "-" */
91      String STRIKETHROUGH_START_MARKUP = "-";
92  
93      /** Syntax for the strikethrough markup end: "-" */
94      String STRIKETHROUGH_END_MARKUP = "-";
95  
96      /** Syntax for the subscript markup start: "-" */
97      String SUBSCRIPT_START_MARKUP = "~";
98  
99      /** Syntax for the subscript markup end: "-" */
100     String SUBSCRIPT_END_MARKUP = "~";
101 
102     /** Syntax for the superscript markup start: "-" */
103     String SUPERSCRIPT_START_MARKUP = "^";
104 
105     /** Syntax for the superscript markup end: "-" */
106     String SUPERSCRIPT_END_MARKUP = "^";
107 
108     /** Syntax for the table cell header end markup: "|" */
109     String TABLE_CELL_HEADER_END_MARKUP = "|";
110 
111     /** Syntax for the table cell header start markup: "|" */
112     String TABLE_CELL_HEADER_START_MARKUP = "|";
113 
114     /** Syntax for the table cell markup: "|" */
115     String TABLE_CELL_MARKUP = "|";
116 
117     /** Syntax for the table row markup: "|" */
118     String TABLE_ROW_MARKUP = "|";
119 
120     /** Syntax for the underlined markup start: "-" */
121     String UNDERLINED_START_MARKUP = "+";
122 
123     /** Syntax for the underlined markup end: "-" */
124     String UNDERLINED_END_MARKUP = "+";
125 }