001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.maven.doxia.module.fml;
020
021import javax.swing.text.html.HTML.Tag;
022
023import org.apache.maven.doxia.markup.HtmlMarkup;
024
025/**
026 * List of <code>FML</code> markups.
027 * <br>
028 * FML uses several  {@link javax.swing.text.html.HTML.Tag} and {@link javax.swing.text.html.HTML.Attribute}
029 * as markups and custom tags.
030 *
031 * @author ltheussl
032 * @since 1.0
033 * @deprecated FML is deprecated since 2.2.0 and scheduled for removal in the next major version.
034 *     Convert FAQ pages to Markdown or XDoc, for example with doxia-converter; see
035 *     https://github.com/apache/maven-doxia/issues/1101.
036 */
037@Deprecated
038@SuppressWarnings("checkstyle:interfaceistype")
039public interface FmlMarkup extends HtmlMarkup {
040    /** FML namespace: "http://maven.apache.org/FML/1.0.1" */
041    String FML_NAMESPACE = "http://maven.apache.org/FML/1.0.1";
042
043    /** FML system id: "https://maven.apache.org/xsd/fml-1.0.1.xsd" */
044    String FML_SYSTEM_ID = "https://maven.apache.org/xsd/fml-1.0.1.xsd";
045
046    // ----------------------------------------------------------------------
047    // Specific Fml tags
048    // ----------------------------------------------------------------------
049
050    /** Fml tag for <code>faqs</code> */
051    Tag FAQS_TAG = new Tag() {
052
053        public String toString() {
054            return "faqs";
055        }
056    };
057
058    /** Fml tag for <code>part</code> */
059    Tag PART_TAG = new Tag() {
060
061        public String toString() {
062            return "part";
063        }
064    };
065
066    /** Fml tag for <code>faq</code> */
067    Tag FAQ_TAG = new Tag() {
068
069        public String toString() {
070            return "faq";
071        }
072    };
073
074    /** Fml tag for <code>question</code> */
075    Tag QUESTION_TAG = new Tag() {
076
077        public String toString() {
078            return "question";
079        }
080    };
081
082    /** Fml tag for <code>answer</code> */
083    Tag ANSWER_TAG = new Tag() {
084
085        public String toString() {
086            return "answer";
087        }
088    };
089
090    /** Fml tag for <code>source</code> */
091    Tag SOURCE_TAG = new Tag() {
092
093        public String toString() {
094            return "source";
095        }
096    };
097
098    /**
099     * Fml tag for <code>macro</code>
100     * @since 1.1.1
101     */
102    Tag MACRO_TAG = new Tag() {
103
104        public String toString() {
105            return "macro";
106        }
107    };
108}