001package org.apache.maven.doxia.module.apt; 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; 023import org.codehaus.plexus.util.StringUtils; 024 025/** 026 * This interface defines all markups and syntaxes used by the <b>APT</b> format. 027 * 028 * @see <a href="http://maven.apache.org/doxia/references/apt-format.html">http://maven.apache.org/doxia/references/apt-format.html</a> 029 * 030 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a> 031 * @version $Id$ 032 * @since 1.0 033 */ 034public interface AptMarkup 035 extends TextMarkup 036{ 037 // ---------------------------------------------------------------------- 038 // Markup separators 039 // ---------------------------------------------------------------------- 040 041 /** APT backslash markup char: '\\' */ 042 char BACKSLASH = '\\'; 043 044 /** APT comment markup char: '~' */ 045 char COMMENT = '~'; 046 047 /** APT numbering decimal markup char: '1' */ 048 char NUMBERING = '1'; 049 050 /** APT numbering lower alpha markup char: 'a' */ 051 char NUMBERING_LOWER_ALPHA_CHAR = 'a'; 052 053 /** APT numbering lower roman markup char: 'i' */ 054 char NUMBERING_LOWER_ROMAN_CHAR = 'i'; 055 056 /** APT numbering upper alpha markup char: 'A' */ 057 char NUMBERING_UPPER_ALPHA_CHAR = 'A'; 058 059 /** APT numbering upper roman markup char: 'I' */ 060 char NUMBERING_UPPER_ROMAN_CHAR = 'I'; 061 062 /** APT page break markup char: '\f' */ 063 char PAGE_BREAK = '\f'; 064 065 /** APT percent markup char: '%' */ 066 char PERCENT = '%'; 067 068 /** APT tab markup char: '\t' */ 069 char TAB = '\t'; 070 071 // ---------------------------------------------------------------------- 072 // Markup syntax 073 // ---------------------------------------------------------------------- 074 075 /** Syntax for the anchor end: "}" */ 076 String ANCHOR_END_MARKUP = String.valueOf( RIGHT_CURLY_BRACKET ); 077 078 /** Syntax for the anchor start: "{" */ 079 String ANCHOR_START_MARKUP = String.valueOf( LEFT_CURLY_BRACKET ); 080 081 /** Syntax for the bold style end: ">>" */ 082 String BOLD_END_MARKUP = StringUtils.repeat( String.valueOf( GREATER_THAN ), 2 ); 083 084 /** Syntax for the bold style start: "<<" */ 085 String BOLD_START_MARKUP = StringUtils.repeat( String.valueOf( LESS_THAN ), 2 ); 086 087 /** Syntax for the boxed verbatim start: "+------+" */ 088 String BOXED_VERBATIM_START_MARKUP = String.valueOf( PLUS ) 089 + StringUtils.repeat( String.valueOf( MINUS ), 6 ) + String.valueOf( PLUS ); 090 091 /** Syntax for the header start: " -----" */ 092 String HEADER_START_MARKUP = String.valueOf( SPACE ) + StringUtils.repeat( String.valueOf( MINUS ), 5 ); 093 094 /** Syntax for the horizontal rule: "========" */ 095 String HORIZONTAL_RULE_MARKUP = StringUtils.repeat( String.valueOf( EQUAL ), 8 ); 096 097 /** Syntax for the italic style end: ">" */ 098 String ITALIC_END_MARKUP = String.valueOf( GREATER_THAN ); 099 100 /** Syntax for the italic style start: "<" */ 101 String ITALIC_START_MARKUP = String.valueOf( LESS_THAN ); 102 103 /** Syntax for the link end: "}}" */ 104 String LINK_END_MARKUP = StringUtils.repeat( String.valueOf( RIGHT_CURLY_BRACKET ), 2 ); 105 106 /** Syntax for the link start: "{{{" */ 107 String LINK_START_1_MARKUP = StringUtils.repeat( String.valueOf( LEFT_CURLY_BRACKET ), 3 ); 108 109 /** Syntax for the link start: "}" */ 110 String LINK_START_2_MARKUP = String.valueOf( RIGHT_CURLY_BRACKET ); 111 112 /** Syntax for the list end: "[]" */ 113 String LIST_END_MARKUP = String.valueOf( LEFT_SQUARE_BRACKET ) + String.valueOf( RIGHT_SQUARE_BRACKET ); 114 115 /** Syntax for the list start: "*" */ 116 String LIST_START_MARKUP = String.valueOf( STAR ); 117 118 /** Syntax for the mono-spaced style end: ">>>" */ 119 String MONOSPACED_END_MARKUP = StringUtils.repeat( String.valueOf( GREATER_THAN ), 3 ); 120 121 /** Syntax for the mono-spaced style start: "<<<" */ 122 String MONOSPACED_START_MARKUP = StringUtils.repeat( String.valueOf( LESS_THAN ), 3 ); 123 124 /** Syntax for the non boxed verbatim start: "------" */ 125 String NON_BOXED_VERBATIM_START_MARKUP = StringUtils.repeat( String.valueOf( MINUS ), 6 ); 126 127 /** Syntax for the non breaking space: "\ " */ 128 String NON_BREAKING_SPACE_MARKUP = String.valueOf( BACKSLASH ) + String.valueOf( SPACE ); 129 130 /** Syntax for the page break: "\f" */ 131 String PAGE_BREAK_MARKUP = String.valueOf( PAGE_BREAK ); 132 133 /** Syntax for the section title start: "*" */ 134 String SECTION_TITLE_START_MARKUP = String.valueOf( STAR ); 135 136 /** Syntax for the table cell start: "|" */ 137 String TABLE_CELL_SEPARATOR_MARKUP = String.valueOf( PIPE ); 138 139 /** Syntax for the table column, centered style: "-*" */ 140 String TABLE_COL_CENTERED_ALIGNED_MARKUP = StringUtils.repeat( String.valueOf( MINUS ), 2 ) 141 + String.valueOf( STAR ); 142 143 /** Syntax for the table column, left style: "-+" */ 144 String TABLE_COL_LEFT_ALIGNED_MARKUP = StringUtils.repeat( String.valueOf( MINUS ), 2 ) 145 + String.valueOf( PLUS ); 146 147 /** Syntax for the table column, right style: "-:" */ 148 String TABLE_COL_RIGHT_ALIGNED_MARKUP = StringUtils.repeat( String.valueOf( MINUS ), 2 ) 149 + String.valueOf( COLON ); 150 151 /** Syntax for the table row end: "|" */ 152 String TABLE_ROW_SEPARATOR_MARKUP = String.valueOf( PIPE ); 153 154 /** Syntax for the table row start: "*--" */ 155 String TABLE_ROW_START_MARKUP = String.valueOf( STAR ) + StringUtils.repeat( String.valueOf( MINUS ), 2 ); 156 157 /** Syntax for the boxed verbatim end: "+------+" */ 158 String BOXED_VERBATIM_END_MARKUP = BOXED_VERBATIM_START_MARKUP; 159 160 /** Syntax for the non boxed verbatim end: "------" */ 161 String NON_BOXED_VERBATIM_END_MARKUP = NON_BOXED_VERBATIM_START_MARKUP; 162}