001package org.apache.maven.doxia.module.fml;
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.HtmlMarkup;
025
026/**
027 * List of <code>FML</code> markups.
028 * <br>
029 * FML uses several  {@link javax.swing.text.html.HTML.Tag} and {@link javax.swing.text.html.HTML.Attribute}
030 * as markups and custom tags.
031 *
032 * @author ltheussl
033 * @since 1.0
034 */
035@SuppressWarnings( "checkstyle:interfaceistype" )
036public interface FmlMarkup
037    extends HtmlMarkup
038{
039    /** FML namespace: "http://maven.apache.org/FML/1.0.1" */
040    String FML_NAMESPACE = "http://maven.apache.org/FML/1.0.1";
041
042    /** FML system id: "https://maven.apache.org/xsd/fml-1.0.1.xsd" */
043    String FML_SYSTEM_ID = "https://maven.apache.org/xsd/fml-1.0.1.xsd";
044
045    // ----------------------------------------------------------------------
046    // Specific Fml tags
047    // ----------------------------------------------------------------------
048
049    /** Fml tag for <code>faqs</code> */
050    Tag FAQS_TAG = new Tag()
051    {
052        /** {@inheritDoc} */
053        public String toString()
054        {
055            return "faqs";
056        }
057    };
058
059    /** Fml tag for <code>part</code> */
060    Tag PART_TAG = new Tag()
061    {
062        /** {@inheritDoc} */
063        public String toString()
064        {
065            return "part";
066        }
067    };
068
069    /** Fml tag for <code>faq</code> */
070    Tag FAQ_TAG = new Tag()
071    {
072        /** {@inheritDoc} */
073        public String toString()
074        {
075            return "faq";
076        }
077    };
078
079    /** Fml tag for <code>question</code> */
080    Tag QUESTION_TAG = new Tag()
081    {
082        /** {@inheritDoc} */
083        public String toString()
084        {
085            return "question";
086        }
087    };
088
089    /** Fml tag for <code>answer</code> */
090    Tag ANSWER_TAG = new Tag()
091    {
092        /** {@inheritDoc} */
093        public String toString()
094        {
095            return "answer";
096        }
097    };
098
099    /** Fml tag for <code>source</code> */
100    Tag SOURCE_TAG = new Tag()
101    {
102        /** {@inheritDoc} */
103        public String toString()
104        {
105            return "source";
106        }
107    };
108
109    /**
110     * Fml tag for <code>macro</code>
111     * @since 1.1.1
112     */
113    Tag MACRO_TAG = new Tag()
114    {
115        /** {@inheritDoc} */
116        public String toString()
117        {
118            return "macro";
119        }
120    };
121}