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 * @version $Id$ 034 * @since 1.0 035 */ 036@SuppressWarnings( "checkstyle:interfaceistype" ) 037public interface FmlMarkup 038 extends HtmlMarkup 039{ 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: "http://maven.apache.org/xsd/fml-1.0.1.xsd" */ 044 String FML_SYSTEM_ID = "http://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 /** {@inheritDoc} */ 054 public String toString() 055 { 056 return "faqs"; 057 } 058 }; 059 060 /** Fml tag for <code>part</code> */ 061 Tag PART_TAG = new Tag() 062 { 063 /** {@inheritDoc} */ 064 public String toString() 065 { 066 return "part"; 067 } 068 }; 069 070 /** Fml tag for <code>faq</code> */ 071 Tag FAQ_TAG = new Tag() 072 { 073 /** {@inheritDoc} */ 074 public String toString() 075 { 076 return "faq"; 077 } 078 }; 079 080 /** Fml tag for <code>question</code> */ 081 Tag QUESTION_TAG = new Tag() 082 { 083 /** {@inheritDoc} */ 084 public String toString() 085 { 086 return "question"; 087 } 088 }; 089 090 /** Fml tag for <code>answer</code> */ 091 Tag ANSWER_TAG = new Tag() 092 { 093 /** {@inheritDoc} */ 094 public String toString() 095 { 096 return "answer"; 097 } 098 }; 099 100 /** Fml tag for <code>source</code> */ 101 Tag SOURCE_TAG = new Tag() 102 { 103 /** {@inheritDoc} */ 104 public String toString() 105 { 106 return "source"; 107 } 108 }; 109 110 /** 111 * Fml tag for <code>macro</code> 112 * @since 1.1.1 113 */ 114 Tag MACRO_TAG = new Tag() 115 { 116 /** {@inheritDoc} */ 117 public String toString() 118 { 119 return "macro"; 120 } 121 }; 122}