001package org.apache.maven.doxia.module.twiki;
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 javax.swing.text.html.HTML.Tag;
023
024import org.apache.maven.doxia.markup.TextMarkup;
025
026/**
027 * This interface defines all markups and syntaxes used by the <b>TWiki</b> format.
028 *
029 * @see <a href="http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules">http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules</a>
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 TWikiMarkup
036    extends TextMarkup
037{
038    // ----------------------------------------------------------------------
039    // Twiki markups
040    // ----------------------------------------------------------------------
041
042    /** Syntax for the anchor : '#' */
043    char ANCHOR_MARKUP = '#';
044
045    /** Syntax for the start line separator: "   " */
046    String THREE_SPACES_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 bold italic markup: "__" */
055    String BOLD_ITALIC_END_MARKUP = "__";
056
057    /** Syntax for the bold italic markup: "__" */
058    String BOLD_ITALIC_START_MARKUP = "__";
059
060    /** Syntax for the bold monospaced markup: "==" */
061    String BOLD_MONOSPACED_END_MARKUP = "==";
062
063    /** Syntax for the bold monospaced markup: "==" */
064    String BOLD_MONOSPACED_START_MARKUP = "==";
065
066    /** Syntax for the definition list item: "   $ " */
067    String DEFINITION_LIST_ITEM_MARKUP = THREE_SPACES_MARKUP + "$ ";
068
069    /** Syntax for the definition list definition: ": " */
070    String DEFINITION_LIST_DEFINITION_MARKUP = ": ";
071
072    /** Syntax for the horizontal rule markup: "---" */
073    String HORIZONTAL_RULE_MARKUP = "---";
074
075    /** Syntax for the italic markup: "_" */
076    String ITALIC_END_MARKUP = "_";
077
078    /** Syntax for the italic markup: "_" */
079    String ITALIC_START_MARKUP = "_";
080
081    /** Syntax for the link end markup: "]]" */
082    String LINK_END_MARKUP = "]]";
083
084    /** Syntax for the link middle markup: "][" */
085    String LINK_MIDDLE_MARKUP = "][";
086
087    /** Syntax for the link start markup: "[[" */
088    String LINK_START_MARKUP = "[[";
089
090    /** Syntax for the list item markup: "* */
091    String LIST_ITEM_MARKUP = "* ";
092
093    /** Syntax for the mono-spaced style end: "=" */
094    String MONOSPACED_END_MARKUP = "=";
095
096    /** Syntax for the mono-spaced style start: "=" */
097    String MONOSPACED_START_MARKUP = "=";
098
099    /** Syntax for the numbering decimal markup char: "1." */
100    String NUMBERING_MARKUP = "1.";
101
102    /** Syntax for the numbering lower alpha markup char: "a." */
103    String NUMBERING_LOWER_ALPHA_MARKUP = "a.";
104
105    /** Syntax for the numbering lower roman markup char: "i." */
106    String NUMBERING_LOWER_ROMAN_MARKUP = "i.";
107
108    /** Syntax for the numbering upper alpha markup char: "A." */
109    String NUMBERING_UPPER_ALPHA_MARKUP = "A.";
110
111    /** Syntax for the numbering upper roman markup char: "I." */
112    String NUMBERING_UPPER_ROMAN_MARKUP = "I.";
113
114    /** Syntax for the table cell header end markup: "* |" */
115    String TABLE_CELL_HEADER_END_MARKUP = "* |";
116
117    /** Syntax for the table cell header start markup: " *" */
118    String TABLE_CELL_HEADER_START_MARKUP = " *";
119
120    /** Syntax for the table cell markup: "| " */
121    String TABLE_CELL_MARKUP = " |";
122
123    /** Syntax for the table row markup: "|" */
124    String TABLE_ROW_MARKUP = "|";
125
126    // ----------------------------------------------------------------------
127    // Specific Twiki tags
128    // ----------------------------------------------------------------------
129
130    /** TWiki tag for <code>verbatim</code> */
131    Tag VERBATIM_TAG = new Tag()
132    {
133        /** {@inheritDoc} */
134        public String toString()
135        {
136            return "verbatim";
137        }
138    };
139}