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: TWikiMarkup.html 905940 2014-04-12 16:27:29Z hboutemy $
032 * @since 1.0
033 */
034public interface TWikiMarkup
035    extends TextMarkup
036{
037    // ----------------------------------------------------------------------
038    // Twiki markups
039    // ----------------------------------------------------------------------
040
041    /** Syntax for the anchor : '#' */
042    char ANCHOR_MARKUP = '#';
043
044    /** Syntax for the start line separator: "   " */
045    String THREE_SPACES_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 bold italic markup: "__" */
054    String BOLD_ITALIC_END_MARKUP = "__";
055
056    /** Syntax for the bold italic markup: "__" */
057    String BOLD_ITALIC_START_MARKUP = "__";
058
059    /** Syntax for the bold monospaced markup: "==" */
060    String BOLD_MONOSPACED_END_MARKUP = "==";
061
062    /** Syntax for the bold monospaced markup: "==" */
063    String BOLD_MONOSPACED_START_MARKUP = "==";
064
065    /** Syntax for the definition list item: "   $ " */
066    String DEFINITION_LIST_ITEM_MARKUP = THREE_SPACES_MARKUP + "$ ";
067
068    /** Syntax for the definition list definition: ": " */
069    String DEFINITION_LIST_DEFINITION_MARKUP = ": ";
070
071    /** Syntax for the horizontal rule markup: "---" */
072    String HORIZONTAL_RULE_MARKUP = "---";
073
074    /** Syntax for the italic markup: "_" */
075    String ITALIC_END_MARKUP = "_";
076
077    /** Syntax for the italic markup: "_" */
078    String ITALIC_START_MARKUP = "_";
079
080    /** Syntax for the link end markup: "]]" */
081    String LINK_END_MARKUP = "]]";
082
083    /** Syntax for the link middle markup: "][" */
084    String LINK_MIDDLE_MARKUP = "][";
085
086    /** Syntax for the link start markup: "[[" */
087    String LINK_START_MARKUP = "[[";
088
089    /** Syntax for the list item markup: "* */
090    String LIST_ITEM_MARKUP = "* ";
091
092    /** Syntax for the mono-spaced style end: "=" */
093    String MONOSPACED_END_MARKUP = "=";
094
095    /** Syntax for the mono-spaced style start: "=" */
096    String MONOSPACED_START_MARKUP = "=";
097
098    /** Syntax for the numbering decimal markup char: "1." */
099    String NUMBERING_MARKUP = "1.";
100
101    /** Syntax for the numbering lower alpha markup char: "a." */
102    String NUMBERING_LOWER_ALPHA_MARKUP = "a.";
103
104    /** Syntax for the numbering lower roman markup char: "i." */
105    String NUMBERING_LOWER_ROMAN_MARKUP = "i.";
106
107    /** Syntax for the numbering upper alpha markup char: "A." */
108    String NUMBERING_UPPER_ALPHA_MARKUP = "A.";
109
110    /** Syntax for the numbering upper roman markup char: "I." */
111    String NUMBERING_UPPER_ROMAN_MARKUP = "I.";
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    // ----------------------------------------------------------------------
126    // Specific Twiki tags
127    // ----------------------------------------------------------------------
128
129    /** TWiki tag for <code>verbatim</code> */
130    Tag VERBATIM_TAG = new Tag()
131    {
132        /** {@inheritDoc} */
133        public String toString()
134        {
135            return "verbatim";
136        }
137    };
138}