001package org.apache.maven.doxia.module.confluence; 002 003/* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022import org.apache.maven.doxia.markup.TextMarkup; 023 024/** 025 * This interface defines all markups and syntaxes used by the <b>Confluence</b> format. 026 * 027 * See <a href="http://confluence.atlassian.com/display/CONF25/Confluence+Notation+Guide+Overview"> 028 * Confluence Notation Guide Overview</a> 029 * 030 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a> 031 * @version $Id$ 032 * @since 1.0 033 */ 034@SuppressWarnings( "checkstyle:interfaceistype" ) 035public interface ConfluenceMarkup 036 extends TextMarkup 037{ 038 // ---------------------------------------------------------------------- 039 // Confluence markups 040 // ---------------------------------------------------------------------- 041 042 /** Syntax for the anchor : "{anchor:" */ 043 String ANCHOR_START_MARKUP = "{anchor:"; 044 045 /** Syntax for the anchor : "}" */ 046 String ANCHOR_END_MARKUP = "}"; 047 048 /** Syntax for the bold markup: "*" */ 049 String BOLD_END_MARKUP = "*"; 050 051 /** Syntax for the bold markup: "*" */ 052 String BOLD_START_MARKUP = "*"; 053 054 /** Syntax for the figure markup: "!" */ 055 String FIGURE_END_MARKUP = "!"; 056 057 /** Syntax for the figure markup: "!" */ 058 String FIGURE_START_MARKUP = "!"; 059 060 /** Syntax for the italic markup: "_" */ 061 String ITALIC_END_MARKUP = "_"; 062 063 /** Syntax for the italic markup: "_" */ 064 String ITALIC_START_MARKUP = "_"; 065 066 /** Syntax for the line break markup: "\\\\" */ 067 String LINE_BREAK_MARKUP = "\\\\"; 068 069 /** Syntax for the link end markup: "]" */ 070 String LINK_END_MARKUP = "]"; 071 072 /** Syntax for the link middle markup: "|" */ 073 String LINK_MIDDLE_MARKUP = "|"; 074 075 /** Syntax for the link start markup: "[" */ 076 String LINK_START_MARKUP = "["; 077 078 /** Syntax for the list item markup: "* */ 079 String LIST_ITEM_MARKUP = "* "; 080 081 /** Syntax for the mono-spaced style start: "{{" */ 082 String MONOSPACED_START_MARKUP = "{{"; 083 084 /** Syntax for the mono-spaced style end: "}}" */ 085 String MONOSPACED_END_MARKUP = "}}"; 086 087 /** Syntax for the numbering decimal markup char: "#" */ 088 String NUMBERING_MARKUP = "#"; 089 090 /** Syntax for the strikethrough markup start: "-" */ 091 String STRIKETHROUGH_START_MARKUP = "-"; 092 093 /** Syntax for the strikethrough markup end: "-" */ 094 String STRIKETHROUGH_END_MARKUP = "-"; 095 096 /** Syntax for the subscript markup start: "-" */ 097 String SUBSCRIPT_START_MARKUP = "~"; 098 099 /** 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}