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 * @since 1.0 032 */ 033@SuppressWarnings( "checkstyle:interfaceistype" ) 034public interface ConfluenceMarkup 035 extends TextMarkup 036{ 037 // ---------------------------------------------------------------------- 038 // Confluence markups 039 // ---------------------------------------------------------------------- 040 041 /** Syntax for the anchor : "{anchor:" */ 042 String ANCHOR_START_MARKUP = "{anchor:"; 043 044 /** Syntax for the anchor : "}" */ 045 String ANCHOR_END_MARKUP = "}"; 046 047 /** Syntax for the bold markup: "*" */ 048 String BOLD_END_MARKUP = "*"; 049 050 /** Syntax for the bold markup: "*" */ 051 String BOLD_START_MARKUP = "*"; 052 053 /** Syntax for the citation markup: "??" */ 054 String CITATION_END_MARKUP = "??"; 055 056 /** Syntax for the citation markup: "??" */ 057 String CITATION_START_MARKUP = "??"; 058 059 /** Syntax for the figure markup: "!" */ 060 String FIGURE_END_MARKUP = "!"; 061 062 /** Syntax for the figure markup: "!" */ 063 String FIGURE_START_MARKUP = "!"; 064 065 /** Syntax for the italic markup: "_" */ 066 String ITALIC_END_MARKUP = "_"; 067 068 /** Syntax for the italic markup: "_" */ 069 String ITALIC_START_MARKUP = "_"; 070 071 /** Syntax for the line break markup: "\\\\" */ 072 String LINE_BREAK_MARKUP = "\\\\"; 073 074 /** Syntax for the link end markup: "]" */ 075 String LINK_END_MARKUP = "]"; 076 077 /** Syntax for the link middle markup: "|" */ 078 String LINK_MIDDLE_MARKUP = "|"; 079 080 /** Syntax for the link start markup: "[" */ 081 String LINK_START_MARKUP = "["; 082 083 /** Syntax for the list item markup: <code>"* "</code> */ 084 String LIST_ITEM_MARKUP = "* "; 085 086 /** Syntax for the mono-spaced style start: "{{" */ 087 String MONOSPACED_START_MARKUP = "{{"; 088 089 /** Syntax for the mono-spaced style end: "}}" */ 090 String MONOSPACED_END_MARKUP = "}}"; 091 092 /** Syntax for the numbering decimal markup char: "#" */ 093 String NUMBERING_MARKUP = "#"; 094 095 /** Syntax for the strikethrough markup start: "-" */ 096 String STRIKETHROUGH_START_MARKUP = "-"; 097 098 /** Syntax for the strikethrough markup end: "-" */ 099 String STRIKETHROUGH_END_MARKUP = "-"; 100 101 /** Syntax for the subscript markup start: "-" */ 102 String SUBSCRIPT_START_MARKUP = "~"; 103 104 /** Syntax for the subscript markup end: "-" */ 105 String SUBSCRIPT_END_MARKUP = "~"; 106 107 /** Syntax for the superscript markup start: "-" */ 108 String SUPERSCRIPT_START_MARKUP = "^"; 109 110 /** Syntax for the superscript markup end: "-" */ 111 String SUPERSCRIPT_END_MARKUP = "^"; 112 113 /** Syntax for the table cell header end markup: "|" */ 114 String TABLE_CELL_HEADER_END_MARKUP = "|"; 115 116 /** Syntax for the table cell header start markup: "|" */ 117 String TABLE_CELL_HEADER_START_MARKUP = "|"; 118 119 /** Syntax for the table cell markup: "|" */ 120 String TABLE_CELL_MARKUP = "|"; 121 122 /** Syntax for the table row markup: "|" */ 123 String TABLE_ROW_MARKUP = "|"; 124 125 /** Syntax for the underlined markup start: "-" */ 126 String UNDERLINED_START_MARKUP = "+"; 127 128 /** Syntax for the underlined markup end: "-" */ 129 String UNDERLINED_END_MARKUP = "+"; 130}