View Javadoc

1   package org.apache.maven.doxia.module.fml;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import javax.swing.text.html.HTML.Tag;
23  
24  import org.apache.maven.doxia.markup.HtmlMarkup;
25  
26  /**
27   * List of <code>FML</code> markups.
28   * <br/>
29   * FML uses several  {@link javax.swing.text.html.HTML.Tag} and {@link javax.swing.text.html.HTML.Attribute}
30   * as markups and custom tags.
31   *
32   * @author ltheussl
33   * @version $Id: FmlMarkup.java 784718 2009-06-15 10:28:18Z vsiveton $
34   * @since 1.0
35   */
36  public interface FmlMarkup
37      extends HtmlMarkup
38  {
39      /** FML namespace: "http://maven.apache.org/FML/1.0.1" target="alexandria_uri">http://maven.apache.org/FML/1.0.1" */
40      String FML_NAMESPACE = "http://maven.apache.org/FML/1.0.1";
41  
42      /** FML system id: "http://maven.apache.org/xsd/fml-1.0.1.xsd" target="alexandria_uri">http://maven.apache.org/xsd/fml-1.0.1.xsd" */
43      String FML_SYSTEM_ID = "http://maven.apache.org/xsd/fml-1.0.1.xsd";
44  
45      // ----------------------------------------------------------------------
46      // Specific Fml tags
47      // ----------------------------------------------------------------------
48  
49      /** Fml tag for <code>faqs</code> */
50      Tag FAQS_TAG = new Tag()
51      {
52          /** {@inheritDoc} */
53          public String toString()
54          {
55              return "faqs";
56          }
57      };
58  
59      /** Fml tag for <code>part</code> */
60      Tag PART_TAG = new Tag()
61      {
62          /** {@inheritDoc} */
63          public String toString()
64          {
65              return "part";
66          }
67      };
68  
69      /** Fml tag for <code>faq</code> */
70      Tag FAQ_TAG = new Tag()
71      {
72          /** {@inheritDoc} */
73          public String toString()
74          {
75              return "faq";
76          }
77      };
78  
79      /** Fml tag for <code>question</code> */
80      Tag QUESTION_TAG = new Tag()
81      {
82          /** {@inheritDoc} */
83          public String toString()
84          {
85              return "question";
86          }
87      };
88  
89      /** Fml tag for <code>answer</code> */
90      Tag ANSWER_TAG = new Tag()
91      {
92          /** {@inheritDoc} */
93          public String toString()
94          {
95              return "answer";
96          }
97      };
98  
99      /** 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 }